Skip to main content
GET
Promotions chart

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Query Parameters

startDate

Start date in ISO 8601 format. Keep this date when requesting older results.

endDate

End date in ISO 8601 format. Use an earlier date to request older results.

Response

Successful response

claims
object
required
offers
object
required