Skip to main content
GET
/
v3
/
background-jobs
List background jobs
curl --request GET \
  --url https://api.reply.io/v3/background-jobs \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "Scheduled",
      "category": "<string>",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "progress": 0.5
    }
  ],
  "hasMore": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.reply.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Query Parameters

​
top
integer

Maximum number of items to return (default 100, max 200)

​
skip
integer

Number of items to skip

​
category
string

Category suffix to filter by — prefix-matched against r2/bg-jobs/{suffix}. For example, pass email-validation to list only email-validation jobs. Omit to list all of the user's background jobs.

Response

Paginated list of background jobs

​
items
Background Job List Item · object[]
​
hasMore
boolean

Whether more items are available beyond the current page