How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extole Persons API

The Persons API from Extole — 28 operation(s) for persons.

Extole Persons API is one of 44 APIs that Extole publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Persons. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 37 operations across 28 paths, and defines 45 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{brand}.extole.io.

37 operations 28 paths 45 schemas 2 DELETE26 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.extole.io
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Extole Persons API declares 3 security schemes for authenticating requests. An API key is passed in the cookie as extole_token (COOKIE). An API key is passed in the header as Authorization (HEADER). An API key is passed in the query as access_token (QUERY). By default, every request must be authenticated.

Paths & Operations 37

Across 28 paths, the API surfaces 37 operations — 2 DELETE, 26 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Persons 37
GET
/api/v4/person/profile-picture-url/{personId}deprecated
Get a person's profile picture URL (legacy)
getPersonProfilePictureUrlV4 1 param → 200400401403415429
GET
/api/v4/person/{personId}deprecated
Get a public person profile (legacy)
getPublicPersonV4 1 param → 200400401403415429
GET
/v5/persons
Search for persons
searchPersons 4 params → 200400401402403415429
POST
/v5/persons
Create a person
createPerson_2 body → 200400401402403415429
GET
/v5/persons/partner-keys
List partner keys
getPartnerKeys_2 1 param → 200400401402403415429
GET
/v5/persons/{person_id}
Get a person
getPerson_3 1 param → 200400401402403415429
PUT
/v5/persons/{person_id}
Update a person
updatePerson_2 1 param body → 200400401402403415429
GET
/v5/persons/{person_id}/block
Get person block status
getPersonBlock 1 param → 200400401402403415429
PUT
/v5/persons/{person_id}/block
Update person block status
updatePersonBlock 1 param body → 200400401402403415429
GET
/v5/persons/{person_id}/data
List person data parameters
listPersonData 5 params → 200400401402403415429
POST
/v5/persons/{person_id}/data
Create a person data parameter
createPersonData 1 param body → 200400401402403415429
GET
/v5/persons/{person_id}/data/{name}
Get a person data parameter
getPersonData 2 params → 200400401402403415429
PUT
/v5/persons/{person_id}/data/{name}
Update a person data parameter
updatePersonData 2 params body → 200400401402403415429
DELETE
/v5/persons/{person_id}/data/{name}
Delete a person data parameter
deletePersonData 2 params → 200400401402403415429
GET
/v5/persons/{person_id}/identity-history
Get identity history for a person
getIdentityHistory 1 param → 200400401402403415429
GET
/v5/persons/{person_id}/journeys
List person journeys
listPersonJourneys 12 params → 200400401402403415429
GET
/v5/persons/{person_id}/journeys/{journey_id}
Get a person journey
getPersonJourney 2 params → 200400401402403415429
GET
/v5/persons/{person_id}/locations
List person locations
listPersonLocations 4 params → 200400401402403415429
GET
/v5/persons/{person_id}/memberships
List person audience memberships
listPersonMemberships 5 params → 200400401402403415429
POST
/v5/persons/{person_id}/memberships
Create a person audience membership
createPersonMembership 1 param body → 200400401402403415429
GET
/v5/persons/{person_id}/relationships
List person relationships
listPersonRelationships 12 params → 200400401402403415429
GET
/v5/persons/{person_id}/rewards
List person rewards
listPersonRewards 13 params → 200400401402403415429
GET
/v5/persons/{person_id}/rewards/{reward_id}
Get a person reward
getPersonReward 2 params → 200400401402403415429
GET
/v5/persons/{person_id}/shareables
List person shareables
listPersonShareables 6 params → 200400401402403415429
POST
/v5/persons/{person_id}/shareables
Create a person shareable
createPersonShareable 1 param body → 200400401402403415429
GET
/v5/persons/{person_id}/shareables/{code}
Get a person shareable
getPersonShareable 2 params → 200400401402403415429
PUT
/v5/persons/{person_id}/shareables/{code}
Update a person shareable
updatePersonShareable 2 params body → 200400401402403415429
GET
/v5/persons/{person_id}/shares
List person shares
listPersonShares 8 params → 200400401402403415429
GET
/v5/persons/{person_id}/shares/{share_id}
Get a person share
getPersonShare 2 params → 200400401402403415429
GET
/v5/persons/{person_id}/steps
List person steps
listPersonSteps 15 params → 200400401402403415429
POST
/v5/persons/{person_id}/forward
Forward an identity profile to another identity profile
forward 1 param body → 200400401402403415429
DELETE
/v5/persons/{person_id}/memberships/{audience_id}
Delete a person audience membership
deletePersonMembership 2 params → 200400401402403415429
GET
/v4/persons/{personId}
Get a public person profile
getPublicPerson 1 param → 200400401403415429
GET
/v4/persons/{personId}/profile-picture-url
Get a person's profile picture URL
getPersonProfilePictureUrl 1 param → 200400401403415429
GET
/v4/persons/{personId}/steps
Get public steps for a person
getPublicPersonSteps 4 params → 200400401403415429
GET
/web/persons/{personId}/assets/download
Download a person asset by name
downloadWebPersonAssetByName 3 params → 200400401403415429
GET
/web/persons/{personId}/assets/{assetId}/download
Download a person asset by ID
downloadWebPersonAssetById 3 params → 200400401403415429

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are PersonRewardResponse (22 properties), PersonStepResponse (17 properties), PersonShareResponse (12 properties), PersonRelationshipResponse (11 properties). Each schema is shown below with its type and property counts.

PersonShareableContentRequest
object
5 properties
PersonIdentityShapeShiftResponse
object
6 required
GeoIp
object
7 properties
PersonShareableUpdateRequest
object
Body of a PUT /v5/persons/{personid}/shareables/{code : .+} request.
5 properties
JourneyKey
object
2 properties
PersonRequest
object
Request body for creating or updating a person profile.
1 property
IdentityKey
object
Name of the identity key used to look up or create this person.
1 property
PersonShareableResponse
object
8 properties 8 required
PersonResponse
object
Person profile returned by the Extole platform.
6 properties 6 required
IdentityLogResponse
4 required
PersonShareableContentResponse
object
Rendered content (subject, message, etc.) for this shareable. Absent if no content template is configured.
5 properties
PersonMembershipResponse
object
4 properties 4 required
Location
object
3 properties
PersonMembershipCreateRequest
object
Body of a POST /v5/persons/{personid}/memberships request.
1 property 1 required
PersonShareResponse
object
12 properties 12 required
ZonedDateTime
string
[RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557section-4) date-time with a num…
PersonShareDataResponse
object
Named data parameters attached to this share.
2 properties
PartnerEventIdResponse
objectnull
2 properties
PersonShareableDataResponse
object
Named data parameters attached to this shareable.
2 properties
PersonBlockResponse
object
3 properties 3 required
PersonStepResponse
object
17 properties 17 required
PersonDataUpdateRequest
object
Body of a PUT /v5/persons/{personid}/data/{name} request.
2 properties
Country
object
2 properties
PersonDataCreateRequest
object
Body of a POST /v5/persons/{personid}/data request.
3 properties 2 required
PersonShareableCreateRequest
object
Body of a POST /v5/persons/{personid}/shareables request.
6 properties 1 required
PersonDataResponse
object
6 properties 6 required
PersonForwardRequest
object
1 property 1 required
PersonRewardResponse
object
22 properties 22 required
PersonBlockRequest
object
2 properties 2 required
RestExceptionResponse
object
Represents the API error response
5 properties 5 required
PublicPersonV4Response
object
4 properties 4 required
State
object
2 properties
PersonRewardDataResponse
object
Named data parameters attached to this reward.
2 properties
PublicPersonStepResponse
object
6 properties 6 required
PersonLocationResponse
object
9 properties 9 required
PersonRelationshipDataResponse
object
Named data parameters attached to this relationship.
2 properties
City
object
1 property
PersonJourneyResponse
object
9 properties 9 required
IdentityLogResponseBase
object
4 properties
PersonStepDataResponse
object
Named data parameters attached to this step.
3 properties
PersonIdentityHistoryResponse
object
8 required
PublicPersonResponse
object
4 properties 4 required
PersonRelationshipResponse
object
11 properties 11 required
PersonJourneyDataResponse
object
Named data parameters attached to this journey entry.
4 properties
PersonLocaleResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extole-persons-api-openapi.yml Raw ↑

Other APIs Extole publishes across the network.

Extole Audiences API
Extole Authentication API
Extole Batch Jobs API
Extole Blocks API
Extole Campaign Controllers Actions API
Extole Campaign Controllers API
Extole Campaign Controllers Triggers API
Extole Campaign Flow Steps API
Extole Campaigns API
Extole Components API
Extole Components Grants API
Extole Components Settings API
Where this information came from

This is an independent, third-party profile of Extole Persons API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.