List bulk jobs

GET 
/v2/bulk_jobs

Fetches multiple bulk job records. The records can be filtered, paged, and sorted according to the respective parameters.

Request

Query Parameters

state string[]

The state of the bulk job. Accepts multiple states. Each state must be one of: open, executing, done

id object

Filter by id using comparison operators. Only supports greater than (gt) comparison (i.e. id[gt]=123)

per_page integer

How many records to show per page in the range [1, 100]. Defaults to 25

Responses

200

Success

application/json

Schema

Schema

• Array [
updated_at date-time

When this bulk job was updated

type string

Type of the Bulk Job.

total integer

Number of total records for this Bulk Job

state string

State of the Bulk Job. Must be one of: open, executing, done.

started_at date-time

When this bulk job started processing. null until bulk job is done

scopes string[]

Scopes

ready_to_execute boolean

Whether the Bulk Job is ready to be executed

processed integer

Number of processed records at the time of request for this Bulk Job

name string

Name of this Bulk Job

marked_ready_at date-time

When this bulk job was marked as ready to execute

id integer

ID of this Bulk Job

finished_at date-time

When this bulk job finished processing

errors integer

Number of errored records at the time of request for this Bulk Job

created_at date-time

When this bulk job was created

• ]

Example (from schema)

[
  {
    "updated_at": "2019-01-02T00:00:00-05:00",
    "type": "person/upsert",
    "total": 1234,
    "state": "open",
    "started_at": "2019-01-02T00:00:00-05:00",
    "scopes": [
      "person:set_crm_id"
    ],
    "ready_to_execute": false,
    "processed": 50,
    "name": "Job Name",
    "marked_ready_at": "2019-01-02T00:00:00-05:00",
    "id": 1,
    "finished_at": "2019-01-02T00:00:00-05:00",
    "errors": 23,
    "created_at": "2019-01-01T00:00:00-05:00"
  }
]

Loading...