v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Persons

List person shares

Returns all share events for the specified person, sorted by created date in descending order. A share is recorded each time the person distributes a shareable link via a channel (social, email, etc.).

get/v5/persons/{person_id}/shares

Path parameters

person_idstring required

The Extole unique profile identifier of this user at Extole.

Query parameters

programsstring[]

campaign_idsstring[]

partner_idsstring[]

data_keysstring[]

data_valuesstring[]

offsetinteger

limitinteger

Response

Successful response

campaign_idstring required

Extole campaign id associated with this share.

channelstring required

Channel through which the share was sent (e.g. email, sms). Absent if not recorded.

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 share.

idstring required

Extole-assigned unique identifier for this share.

linkstring required

Share link URL sent to the friend.

messagestring required

Message body included with the share. Absent if no message was sent.

other_person_idstring required

Extole person id of the friend who received this share. Absent if the friend has not yet joined.

programstring required

Program key associated with this share.

shareable_codestring required

Shareable code used to generate the share link.

subjectstring required

Subject line of the share message. Absent for channels that do not have subjects.

Example response

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