List person relationships

curl --request GET \
  --url https://api.extole.io/v5/persons/{person_id}/relationships \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v5/persons/{person_id}/relationships', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v5/persons/{person_id}/relationships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v5/persons/{person_id}/relationships"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v5/persons/{person_id}/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "campaign_id": "<string>",
    "cause_event_id": "<string>",
    "container": "<string>",
    "created_date": "2025-10-24T02:00:00-07:00",
    "data": {},
    "id": "<string>",
    "my_role": "ADVOCATE",
    "other_person": {
      "id": "<string>",
      "identity_key": {
        "name": "<string>"
      },
      "identity_key_value": "<string>"
    },
    "other_person_id": "<string>",
    "program": "<string>",
    "root_event_id": "<string>",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]

Persons

List person relationships

Returns the referral relationships for the specified person, showing advocate-friend connections created through campaign participation. Each entry carries the requested person’s my_role (ADVOCATE or FRIEND) and the other_person_id on the other side, rather than being split into fixed advocate and friend collections.

Each entry also carries other_person, resolving that person to this client’s identity_key and identity_key_value, so a whole network can be labelled from one request rather than one request per related person. A relationship always names another person, so other_person is always present.

Relationships are de-duplicated by identity, keeping the most recent one per related person, unless include_duplicate_identities is set. When collapsing persons yourself, key on identity_key_value, falling back to other_person_id when the person has no identity key value yet. Never key on email: clients whose identity key is not email routinely have many distinct persons sharing an email or having none, so collapsing on email under-reports the network.

GET

persons

{person_id}

relationships

List person relationships

curl --request GET \
  --url https://api.extole.io/v5/persons/{person_id}/relationships \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v5/persons/{person_id}/relationships', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v5/persons/{person_id}/relationships",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v5/persons/{person_id}/relationships"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v5/persons/{person_id}/relationships")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "campaign_id": "<string>",
    "cause_event_id": "<string>",
    "container": "<string>",
    "created_date": "2025-10-24T02:00:00-07:00",
    "data": {},
    "id": "<string>",
    "my_role": "ADVOCATE",
    "other_person": {
      "id": "<string>",
      "identity_key": {
        "name": "<string>"
      },
      "identity_key_value": "<string>"
    },
    "other_person_id": "<string>",
    "program": "<string>",
    "root_event_id": "<string>",
    "updated_date": "2025-10-24T02:00:00-07:00"
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

person_id

string

required

The Extole unique profile identifier of this user at Extole.

Query Parameters

my_roles

enum<string>[]

Available options:

ADVOCATE,

FRIEND

containers

string[]

programs

string[]

campaign_ids

string[]

data_keys

string[]

data_values

string[]

exclude_anonymous

boolean

include_duplicate_identities

boolean

include_self_referrals

boolean

offset

integer<int32>

limit

integer<int32>

Response

Successful response

campaign_id

string

required

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

cause_event_id

string

required

Id of the direct cause event for this relationship.

container

string

required

Campaign container in which the relationship was established.

created_date

string

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.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

data

object

required

Named data parameters attached to this relationship.

Show child attributes

string

required

read-only

Extole-assigned unique identifier for this relationship.

my_role

enum<string>

required

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

Available options:

ADVOCATE,

FRIEND

other_person

object

required

The other party in a relationship, identified by this client's identity key.

Show child attributes

other_person_id

string

required

Extole person id of the other party in the relationship.

program

string

required

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

root_event_id

string

required

Id of the root event that initiated this relationship.

updated_date

string

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.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

⌘I

Getting Started

Consumer to Extole API

Server to Extole API

Management API

List person relationships

Authorizations

Path Parameters

Query Parameters

Response