Gift links

Read private gift links for matching

One page of a campaign's people with their private claim URL (gift_link, only when availability is ready), expiry and stable source IDs for matching into another system. Others carry availability_reason. Page with limit and nextCursor (null on the last page) and keep the same filters; counts cover the whole filtered set. A cursor from before a campaign change returns 409 CURSOR_STALE: start again. Reading never pays, sends, renews or rotates a link. Accepts an MCP OAuth token with gifts:links:read.

get/campaigns/{id}/distribution

Request

  • Base URL: https://gtmswag.com/api/v1
  • URL: https://gtmswag.com/api/v1/campaigns/{id}/distribution
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://gtmswag.com/oauth/authorize, token URL https://gtmswag.com/oauth/token, scopes: gifts:links:read)

Path parameters

idstring required

Campaign or playbook ID (cmp_).

Query parameters

recipientIdsstring[]

Explicit stable recipient IDs to select.

giftIdsstring[]

Explicit gift/send IDs to select.

searchstring

Filter supplied recipient name, email, source ID, company or profile.

availability'ready' | 'awaiting_approval' | 'preparing_links' | 'unavailable'

Filter current link availability; ready means usable now.

cursorstring

nextCursor from the previous page; keep the same filters. Omit for the first page.

limitinteger

Maximum records in this page, from 1 to 100.

Response

Success: {"data": DistributionRecordsPage}.

Changes

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