Skip to main content
GET
/
v1
/
bumps
List
curl --request GET \
  --url https://{defaultHost}/v1/bumps \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/bumps"
  },
  "data": [
    {
      "id": "ae172eb8-a0b2-4f9b-8720-1facfee93323",
      "object": "bump",
      "amount_off": null,
      "archived": false,
      "archived_at": null,
      "auto_apply": false,
      "filter_match_type": null,
      "filter_price_ids": [],
      "filter_product_ids": [],
      "metadata": {},
      "name": "Bundle Discount",
      "percent_off": null,
      "priority": 5,
      "price": "95b53dc7-118b-4345-a3e8-df9b550a810d",
      "discarded_at": null,
      "created_at": 1767909674,
      "updated_at": 1767909674
    }
  ]
}

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.

product_ids[]
string[]

Only return objects that belong to the given products.

Response

200 - application/json

Success

object
string

A string describing the object type returned.

pagination
object
data
array

An array of objects.