Skip to main content
GET
List background job

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer

The number of items to return

Required range: 1 <= x <= 100
Example:

10

starting_after
string
Example:

"507f1f77bcf86cd799439011"

ids
string

The ID of the job. Multiple IDs can be provided as a comma-separated list

Example:

"676f3caadedbfe9abea3bab4"

included_ids
string

The ID of the job to be included in the response. Multiple IDs can be provided as a comma-separated list

Example:

"676f3caadedbfe9abea3bab4"

excluded_ids
string

The ID of the job to be excluded from the response. Multiple IDs can be provided as a comma-separated list

Example:

"676f3caadedbfe9abea3bab4"

type
enum<string>

The type of the job

Available options:
move-leads,
import-leads,
export-leads,
update-warmup-accounts,
rename-variable,
broadcast-ai-generate,
broadcast-website-scrape,
import-subscribers-from-crm,
resync-subscriber-crm-tags
Example:

"move-leads"

entity_type
enum<string>

The type of the entity

Available options:
list,
campaign,
workspace,
broadcast,
subscriber-group-sync,
subscriber-group
Example:

"list"

entity_id
string

The ID of the entity. Multiple IDs can be provided as a comma-separated list

Example:

"676f3caadedbfe9abea3bab4"

status
string

The status of the job. Multiple statuses can be provided as a comma-separated list. Valid statuses are: pending, in-progress, success, failed, draining, paused, cancelled

Example:

"pending,in-progress"

sort_column
enum<string>

The column to sort the results by

Available options:
created_at,
updated_at
Example:

"created_at"

sort_order
enum<string>

The order to sort the results by

Available options:
asc,
desc
Example:

"desc"

Response

The list of Background Job

items
Background Job · object[]
required

The list of Background Job

next_starting_after
string

The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API

Example:

"019f985c-9295-7cbe-9f46-81e170e78ad0"