Skip to main content
GET
/
v1
/
bulk_actions
List
curl --request GET \
  --url https://{defaultHost}/v1/bulk_actions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/bulk_actions"
  },
  "data": [
    {
      "id": "4b2e7ce7-848f-44ff-9d73-b683df78e1c1",
      "object": "bulk_action",
      "action_type": "delete_products",
      "record_ids": [
        "a14c7070-3278-4e3e-9524-8f9f545dfd9e",
        "58155da5-98ed-4ba6-8b8d-938bc97acfd9",
        "216f1d29-3df3-477a-8a7a-3d4ab7c71dd2",
        "4e9bdf43-5f8f-4cf8-9a71-59d0dc3e3ad3",
        "950870c4-8d32-45df-9e7b-447169e814cd"
      ],
      "skipped_record_ids": [],
      "status": "pending",
      "created_at": 1770234840,
      "updated_at": 1770234840
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.