---
title: "Get a person share"
method: GET
path: "/v5/persons/{person_id}/shares/{share_id}"
tags: ["Persons"]
---

# Get a person share

`GET /v5/persons/{person_id}/shares/{share_id}`

## Request

- Base URL: `https://api.extole.io`
- URL: `https://api.extole.io/v5/persons/{person_id}/shares/{share_id}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in query parameter `access_token`
  - 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)

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

## Path parameters

- `person_id` string, required
- `share_id` string, required

## Response `200`

Successful response

- PersonShareResponse
  - `campaign_id` string, required: Extole campaign id associated with this share.
  - `channel` string, required: Channel through which the share was sent (e.g. `email`, `sms`). Absent if not recorded.
  - `created_date` string, required: [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds.
  - `data` object, required: Named data parameters attached to this share.
  - `id` string, required: Extole-assigned unique identifier for this share.
  - `link` string, required: Share link URL sent to the friend.
  - `message` string, required: Message body included with the share. Absent if no message was sent.
  - `other_person_id` string, required: Extole person id of the friend who received this share. Absent if the friend has not yet joined.
  - `partner_id` PartnerEventIdResponse, nullable, required
    - `name` string: Name of the partner event identifier (e.g. `order_id`).
    - `value` string: Value of the partner event identifier.
  - `program` string, required: Program key associated with this share.
  - `shareable_code` string, required: Shareable code used to generate the share link.
  - `subject` string, required: Subject line of the share message. Absent for channels that do not have subjects.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `415`: Unsupported Media Type
- `429`: Too Many Requests

---

[API](https://skmtc.dev/extole/apis/integration-api-server-to-extole.md) - [All operations](https://skmtc.dev/extole/apis/integration-api-server-to-extole/llms.txt) - [OpenAPI document](https://skmtc.dev/extole/apis/integration-api-server-to-extole/revisions/c16e62e66755?raw)