Sign in

v1

latestOpenAPI 3.0.02026-07-22243670.8 KB
Offers

Get an offer for the authenticated partner

get/v1/offers/{id}

Path parameters

idstring required

Offer ID

Response

Successful response.

aboutstring nullable required

About text for the offer (English)

banner_urlstring uri required

The URL for the offer banner

categorystring required

The category of the offer

ends_atstring date-time nullable required

When the offer ends. Null when the offer has no end date

idstring required

Unique identifier for the object.

logo_urlstring uri required

The URL for the offer logo

namestring required

The name of the offer

object'offer' required

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

slugstring required

The slug identifier of the offer

starts_atstring date-time required

When the offer starts

taglinestring required

Tagline text for the offer (English)

type'sale' | 'swap' required

The type of the offer

Example response

{
  "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",
  "type": "sale"
}