Persons

Get a person share

Returns the specified share event for the given person, including its channel, shareable, and associated campaign journey.

get/v5/persons/{person_id}/shares/{share_id}

Request

Base URL
https://api.extole.io
Auth
- API key in header Authorization
- or API key in query parameter access_token
- or API key in cookie extole_token
TypeScript
https://skmtc.dev/extole/apis/integration-api-server-to-extole/docs/v5/persons/:person_id/shares/:share_id/get.ts
A function with typed inputs. Its response is checked against the schema.

person_idstring required

The Extole unique profile identifier of this user at Extole.

share_idstring required

Share id parameter

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.

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

No recorded changes to this operation across all 1 revision of this API.