Gallery Platform API
Reference

List offers

Lists the gallery's offers with cursor pagination. Filter by `status`, fetch an explicit set with `ids` (comma-separated, max 50), and sort by created/updated/sent.

GET
/gallery/offers

Lists the gallery's offers with cursor pagination. Filter by status, fetch an explicit set with ids (comma-separated, max 50), and sort by created/updated/sent.

Authorization

bearerAuth offers:read
AuthorizationBearer <token>

A gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).

In: header

Scope: offers:read

Query Parameters

limit?integer

Page size. Defaults to 20; the maximum is 100.

Range1 <= value <= 100
Default20
cursor?string

Opaque cursor from the previous page's next_cursor. Omit for the first page.

ids?array<string>

Comma-separated ids to fetch as an explicit set (maximum 50).

Items1 <= items <= 50
status?string

Filter to the given status; the schema's enum lists the values.

Value in

  • "draft"
  • "scheduled"
  • "sending"
  • "sent"
  • "canceled"
q?string

Free-text search over the resource's searchable fields.

Lengthlength <= 200
tag_id?array<string>

Filter to the given tag id.

Items1 <= items <= 10
sort?string

Sort by one of: created, updated, sent (default created).

Value in

  • "created"
  • "updated"
  • "sent"
dir?string

Sort direction (default desc).

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

{  "data": [    {      "id": "string",      "title": "string",      "subject": "string",      "intro": "string",      "template_id": "string",      "status": "draft",      "track_engagement": true,      "scheduled_at": "string",      "sent_at": "string",      "cc_emails": [        "string"      ],      "bcc_emails": [        "string"      ],      "created_by": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string"}

Set an offer's items PATCH

Replaces the full set of works in a draft or scheduled offer (the compose surface's save).

List an offer's recommended recipients GET

Returns the contacts the recommendation engine would add to this offer: anyone whose stored match on one of the offer's works clears the visible floor, best first, with the works they matched and the strongest evidence item. Contacts already on the offer are omitted. Empty until the engine has judged the offer's works.