---
title: "Get a person shareable"
method: GET
path: "/v5/persons/{person_id}/shareables/{code}"
tags: ["Persons"]
---

# Get a person shareable

`GET /v5/persons/{person_id}/shareables/{code}`

Returns the shareable for the specified person identified by its share code. A shareable is a unique share link or code that allows a person to invite friends to participate in a referral campaign.

## Path parameters

- `person_id` string, required
- `code` string, required

## Response `200`

Successful response

- PersonShareableResponse
  - `code` string, required — Unique shareable code used to generate this person's referral link.
  - `content` PersonShareableContentResponse, required — Rendered content (subject, message, etc.) for this shareable. Absent if no content template is configured.
    - `description` string — Text description of the shared content. Absent if not set.
    - `image_url` string — URL of the image associated with the shared content. Absent if not set.
    - `partner_content_id` string — Partner-assigned identifier for the shareable content item. Absent if not provided.
    - `title` string — Display title for the shared content. Absent if not set.
    - `url` string — Destination URL for the shared content. Absent if not set.
  - `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 shareable.
  - `key` string, required — Key identifying the shareable template or program slot.
  - `label` string, required — Human-readable label for this shareable. Absent if no label was set.
  - `link` string, required — Full referral link URL for this shareable.
  - `updated_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.

## Other responses

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

---

[API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/revisions/c16e62e66755/schema)