search

List offers

The List Offers endpoint lets a partner retrieve all offers that have been generated for them, so they can review what options were presented and where each offer is in its lifecycle (e.g. received, confirmed, or rejected). It returns the offers in pages and allows narrowing the list down (for example by status or reference).

hashtag
List offers

get
chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read-only access to view offer details.
Authorizations
OAuth2clientCredentialsRequired

XONE API Access Token

To get started with the XONE API, you'll first need to obtain an access token. This token acts as a digital key, granting your application permission to make API calls.

This process uses the OAuth 2.0 Client Credentials Grant flow. You'll use your unique client ID and client secret to request a token, which you then include in subsequent API requests.

🔑 Authentication Steps

  • Request Token: Send a "Retrieve Token" request to the XONE authorization server's token endpoint.
  • Include Credentials: In the request body, provide your client_id and client_secret as a JSON object.
  • Use Token: The server will respond with an access_token that you can now use to authenticate your API calls by including it in the Authorization header as a Bearer token.
Token URL:
Body
objectOptional
Responses
chevron-right
200

200 OK

application/json
get
/api/partners/{partner_id}/offers
PreviousConfirm offerNextGet offer

Last updated