v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Persons

Search for persons

Searches for persons by identity key value or client-defined person keys (supply in name:value format, e.g. partner_conversion_id:abc123). Returns an array because the same key may resolve to multiple Extole profiles. Supply at least one search criterion via query parameters.

get/v5/persons

Query parameters

identity_key_valuestring

person_keysstring[]

limitinteger

offsetinteger

Response

Successful response

idstring required

Extole-assigned unique identifier for this person.

identity_idstring required

Identifier within the identity store that represents this person's merged profile.

identity_key_valuestring required

Value of the identity key for this person.

versionstring required

Optimistic-concurrency version token for the person record.