Skip to main content
GET
/
v1
/
swaps
List
curl --request GET \
  --url https://{defaultHost}/v1/swaps \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/swaps"
  },
  "data": [
    {
      "id": "a50f5d84-c3ac-4c20-9dd8-c07a7ee89103",
      "object": "swap",
      "archived": false,
      "archived_at": null,
      "description": "Swap this price for another",
      "metadata": {},
      "price": "99b90009-c270-46a8-8f27-eec06cfa8cca",
      "swap_price": "f91874a8-151e-4e8b-9f2a-02f7648e9484",
      "discarded_at": null,
      "created_at": 1780335182,
      "updated_at": 1780335182
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.surecart.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

archived
boolean

Only return objects that are archived or not archived.

ids[]
string[]

Only return objects with the given IDs.

limit
integer

A limit on the number of items to be returned, between 1 and 100.

page
integer

The page of items you want returned.

price_ids[]
string[]

Only return objects that belong to the given prices.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.