GuidesAPI Reference
Log In
API Reference

List bulk jobs

Returns all bulk jobs for the current tenant, including completed and cancelled jobs. Jobs are sorted by creation time (newest first) and limited by TTL (24 hours). Supports optional filtering by status, entity, or active state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
length ≥ 1

Filter by entity name.

  • customer - Customer
  • customer_loyalty_program - Customer Loyalty Program
Allowed:
boolean

Filter by active state. True returns only jobs counting towards concurrency limits; False returns only terminal jobs.

integer

Maximum number of results per page

integer

Page of results to retrieve

integer
enum

Filter by job status.

  • 0 - Created
  • 1 - Queued
  • 2 - Processing
  • 3 - Completed
  • 4 - Completed With Errors
  • 5 - Failed
  • 6 - Cancelling
  • 7 - Cancelled
Headers
integer
required

The id of the active store to be used for this API invocation

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json