Get an offer
Returns the offer with its composed items and resolved recipients.
Returns the offer with its composed items and resolved recipients.
Authorization
bearerAuth offers:readA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: offers:read
Path Parameters
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "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", "items": [ { "offer_id": "string", "artwork_id": "string", "position": -9007199254740991, "caption_override": "string", "price_shown_cents": -9007199254740991, "currency": "string", "price_visible": true, "created_at": "string" } ], "recipients": [ { "id": "string", "offer_id": "string", "contact_id": "string", "email": "string", "expires_at": "string", "delivery_status": "pending", "sent_at": "string", "first_opened_at": "string", "last_activity_at": "string", "open_count": -9007199254740991, "click_count": -9007199254740991, "created_at": "string" } ]}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "string", "retry": "permanent", "details": null}Get an offer's engagement GET
The offer's engagement rollup: delivery/open/click totals across recipients, plus a per-artwork view/click/dwell breakdown (most-engaged work first) folded from the tracking event log. Answers 'which works is this offer landing on'.
Set an offer's items PATCH
Replaces the full set of works in a draft or scheduled offer (the compose surface's save).