Skip to main content
GET
/
v1
/
batch_operations
List
curl --request GET \
  --url https://{defaultHost}/v1/batch_operations \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 2,
    "limit": 20,
    "page": 1,
    "url": "/v1/batch_operations"
  },
  "data": [
    {
      "id": "898138a4-78b1-48b7-b27b-06a11cce05db",
      "object": "batch_operation",
      "body": null,
      "http_method": "GET",
      "path": "/v1/products",
      "query_params": null,
      "response_body": null,
      "response_status": null,
      "status": "pending",
      "batch": "51ae2320-3b3d-43d9-8b7c-97d91ff69987",
      "created_at": 1782485805,
      "updated_at": 1782485805
    },
    {
      "id": "b31d5109-3530-4ac7-9ec7-a8f50345ac66",
      "object": "batch_operation",
      "body": null,
      "http_method": "GET",
      "path": "/v1/products",
      "query_params": null,
      "response_body": null,
      "response_status": null,
      "status": "pending",
      "batch": "51ae2320-3b3d-43d9-8b7c-97d91ff69987",
      "created_at": 1782485805,
      "updated_at": 1782485805
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
batch_ids[]
string[]

Only return objects that belong to the given batches.

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

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.