Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Extole

Extole Persons API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.0.1, 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.0.1
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.

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

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
AE Profile APIs.io
Extole Authentication API
AE Profile APIs.io
Extole Batch Jobs API
AE Profile APIs.io
Extole Blocks API
AE Profile APIs.io
Extole Campaign Controllers Actions API
AE Profile APIs.io
Extole Campaign Controllers API
AE Profile APIs.io
Extole Campaign Controllers Triggers API
AE Profile APIs.io
Extole Campaign Flow Steps API
AE Profile APIs.io
Extole Campaigns API
AE Profile APIs.io
Extole Components API
AE Profile APIs.io
Extole Components Grants API
AE Profile APIs.io
Extole Components Settings API
AE Profile APIs.io
#Persons
← Back to E APIs
API Details
ID
extole:extole-persons-api
Base URL
https://api.extole.io
Docs
https://developers.extole.com/
Provider
Extole
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network