Get Person Shares

get

https://api.extole.io/v5/persons/<person_id>/shares

Calling this endpoint allows you to retrieve a list of a program participant's share instances. The list is sorted by share date in descending order.

Path Params

person_id

string

required

Extole's unique profile identifier of the customer.

Query Params

programs

string

A list of Extole program labels (e.g., refer-a-friend). Will include shares that match at least one of the programs.

campaign_ids

string

A list of Extole campaign unique identifiers. Will include shares that match at least one of the campaign IDs.

partner_ids

string

A list of your unique identifiers for the customer. The actual value of the field will be <PARTNER_ID_NAME>: and should be URL encoded.

data_keys

string

A list of data keys (e.g., order_id). Will include shares that match at least one of the data keys.

data_values

string

A list of name:value pairs (e.g., order_id:12345). Will include shares that have at least one of the specified data name-value pairs.

offset

int32

limit

int32

Headers

Authorization

string

Defaults to Bearer {access_token}

Content-Type

string

Defaults to application/json

Responses

Language

Credentials

Header

Request

Response

Choose an example:

application/json

200200