Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Persons

List person relationships

Returns the referral relationships for the specified person, showing advocate-friend connections created through campaign participation.

get/v5/persons/{person_id}/relationships

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Query parameters

my_rolesstring[]
containersstring[]
programsstring[]
campaign_idsstring[]
data_keysstring[]
data_valuesstring[]
exclude_anonymousboolean
include_duplicate_identitiesboolean
include_self_referralsboolean
offsetinteger
limitinteger

Response

Successful response

campaign_idstring required

Extole campaign id associated with this relationship. Absent when no campaign is linked.

cause_event_idstring required

Id of the direct cause event for this relationship.

containerstring required

Campaign container in which the relationship was established.

created_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

dataobject required

Named data parameters attached to this relationship.

idstring required

Extole-assigned unique identifier for this relationship.

my_role'ADVOCATE' | 'FRIEND' required

This person's role in the relationship (ADVOCATE or FRIEND).

other_person_idstring required

Extole person id of the other party in the relationship.

programstring required

Program key associated with this relationship. Absent for relationships with no program context.

root_event_idstring required

Id of the root event that initiated this relationship.

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Example response

[
  {
    "created_date": "2025-10-24T02:00:00-07:00",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]