Bulk Action Progress

get

Retrieve a list of all bulk actions and their current progress statuses.

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Query parameters

actionstringOptional

completedbooleanOptional

custom_object_idstring · uuidOptional

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

started_afterstring · date-timeOptional

Responses

200Success

application/json

get

/api/bulk-action-progress

HTTPcURLJavaScriptPython

GET /api/bulk-action-progress HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "action": "text",
      "status": "text",
      "started_at": "2026-03-03T16:29:18.668Z",
      "completed_at": "2026-03-03T16:29:18.668Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "custom_object": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "object_name": "text",
        "entity_name": "text"
      },
      "pending_count": 1,
      "success_count": 1,
      "failed_count": 1,
      "failure_report": {
        "id": "text",
        "created": "2026-03-03T16:29:18.668Z",
        "key": "text",
        "name": "text",
        "url": "text",
        "thumbnail_url": "text",
        "size_bytes": "text",
        "content_type": "text",
        "size_formatted": "text",
        "is_public": true
      },
      "imported_file": {
        "id": "text",
        "created": "2026-03-03T16:29:18.668Z",
        "key": "text",
        "name": "text",
        "url": "text",
        "thumbnail_url": "text",
        "size_bytes": "text",
        "content_type": "text",
        "size_formatted": "text",
        "is_public": true
      },
      "export_file": {
        "id": "text",
        "created": "2026-03-03T16:29:18.668Z",
        "key": "text",
        "name": "text",
        "url": "text",
        "thumbnail_url": "text",
        "size_bytes": "text",
        "content_type": "text",
        "size_formatted": "text",
        "is_public": true
      }
    }
  ],
  "errors": [
    "error message"
  ]
}

get

Fetch the progress details of a specific bulk action using its unique ID.

Authorizations

apiKey & businessId & userId

X-API-KEYstringRequired

X-BUSINESS-IDstringRequired

X-USER-IDstringRequired

Path parameters

idstringRequiredPattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

200Success

application/json

get

/api/bulk-action-progress/{id}

HTTPcURLJavaScriptPython

GET /api/bulk-action-progress/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
X-BUSINESS-ID: YOUR_API_KEY
X-USER-ID: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "action": "text",
  "status": "text",
  "started_at": "2026-03-03T16:29:18.668Z",
  "completed_at": "2026-03-03T16:29:18.668Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "custom_object": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "object_name": "text",
    "entity_name": "text"
  },
  "pending_count": 1,
  "success_count": 1,
  "failed_count": 1,
  "failure_report": {
    "id": "text",
    "created": "2026-03-03T16:29:18.668Z",
    "key": "text",
    "name": "text",
    "url": "text",
    "thumbnail_url": "text",
    "size_bytes": "text",
    "content_type": "text",
    "size_formatted": "text",
    "is_public": true
  },
  "imported_file": {
    "id": "text",
    "created": "2026-03-03T16:29:18.668Z",
    "key": "text",
    "name": "text",
    "url": "text",
    "thumbnail_url": "text",
    "size_bytes": "text",
    "content_type": "text",
    "size_formatted": "text",
    "is_public": true
  },
  "export_file": {
    "id": "text",
    "created": "2026-03-03T16:29:18.668Z",
    "key": "text",
    "name": "text",
    "url": "text",
    "thumbnail_url": "text",
    "size_bytes": "text",
    "content_type": "text",
    "size_formatted": "text",
    "is_public": true
  }
}