v1

latestOpenAPI 3.0.02026-07-22243670.8 KB

Offers

List offers for the authenticated partner

get/v1/offers

Query parameters

starting_afterstring

A cursor for use in pagination

starting_beforestring

A cursor for use in pagination

limitinteger

A limit on the number of objects to be returned

Example:10

Response

Successful response.

object'list' required

String representing the object's type. Objects of the same type share the same value.

starting_afterstring

String representing the page cursor to used for querying the next page.

starting_beforestring

String representing the page cursor to used for querying the previous page.

Example response

{
  "data": [
    {
      "ends_at": "2025-01-01T00:00:00.000000Z",
      "id": "05edea81-98a7-4582-aa7c-040d57cb1858",
      "options": [
        {
          "id": "05edea81-98a7-4582-aa7c-040d57cb1858"
        }
      ],
      "slug": "example-offer",
      "starts_at": "2025-01-01T00:00:00.000000Z",
      "tagline": "Example Offer Tagline",
      "type": "sale"
    }
  ],
  "starting_after": "g3QAAAA...",
  "starting_before": "g3QAAAA..."
}