Skip to main content
GET
Get an offer for the authenticated partner

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization and token endpoints

Path Parameters

id
string
required

Offer ID

Response

Successful response.

Full offer details

about
string | null
required

About text for the offer (English)

asset
object
required

The asset for which the offer is created

banner_url
string<uri>
required

The URL for the offer banner

category
string
required

The category of the offer

ends_at
string<date-time> | null
required

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

Example:

"2025-01-01T00:00:00.000000Z"

faqs
object[]
required

List of FAQs for the offer

funding_assets
object[]
required

List of assets that can be used to fund the offer

id
string
required

Unique identifier for the object.

Example:

"05edea81-98a7-4582-aa7c-040d57cb1858"

List of links related to the offer

logo_url
string<uri>
required

The URL for the offer logo

milestones
object[]
required

List of milestones for the offer

name
string
required

The name of the offer

object
enum<string>
required

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

Available options:
offer
options
OfferOption · object[]
required

List of offer options

slug
string
required

The slug identifier of the offer

Example:

"example-offer"

starts_at
string<date-time>
required

When the offer starts

Example:

"2025-01-01T00:00:00.000000Z"

tagline
string
required

Tagline text for the offer (English)

terms
object[]
required

List of offer terms

type
enum<string>
required

The type of the offer

Available options:
sale,
swap
Example:

"sale"