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

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/get.ts
A function with typed inputs. Its response is checked against the schema.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.

Search for persons

Request

Query parameters

Response 200OK

Changes

Response