Get Person Relationships

get

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

Calling this endpoint allows you to retrieve a list of a customer's relationships with other program participants, sorted by date in descending order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

person_id

string

required

Extole's unique identifier for the customer.

Query Params

my_roles

string

A list of roles for the current person in the relationship (e.g., ADVOCATE, FRIEND). Will include journeys that match at least one of the roles.

containers

string

Defaults to All containers

A list of containers (e.g., production, test, bot). Will include relationships that match at least one of the containers.

programs

string

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

campaign_ids

string

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

data_keys

string

A list of data keys (e.g., order_id) with non-empty values. Will include relationships that have at least one of the data keys.

data_values

string

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

exclude_anonymous

boolean

The flag to exclude relationships with anonymous persons.

include_duplicate-identities

boolean

Defaults to false

The flag to return all relationships. When set to false (default), it will return last relationship per person.

include_self_referrals

boolean

The flat to include self referrals.

offset

int32

limit

int32

Headers

Authorization

string

Defaults to Bearer {access_token}

Content-Type

string

Defaults to application/json

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200200

403403