---
title: "List jobs"
description: "Your background jobs, newest first and cursor-paginated, as Settings → Bulk operations lists them: the kinds an API operation starts that your key may read. `GET /api/v1/jobs`"
url: https://www.unitpost.com/docs/platform/get-jobs
section: "Platform API reference"
updated: 2026-10-13
---
# List jobs

`GET /api/v1/jobs`

Your background jobs, newest first and cursor-paginated, as Settings → Bulk operations lists them: the kinds an API operation starts that your key may read. Filter with `status` or `kind`. Requires the `contacts:read` capability.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer | no | Max rows to return (default 20, max 100). |
| `after` | query | string | no | Return rows after this id (forward paging). |
| `before` | query | string | no | Return rows before this id (backward paging). |
| `status` | query | string | no | QUEUED, RUNNING, COMPLETED, FAILED or CANCELED. One of: `QUEUED`, `RUNNING`, `COMPLETED`, `FAILED`, `CANCELED`. |
| `kind` | query | string | no | One kind, e.g. `contacts.export`, `contact_field.delete` or `contacts.topic_opt_out`. |

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `id` | string | yes | — |
| `kind` | string | yes | — |
| `status` | enum | yes | One of: `QUEUED`, `RUNNING`, `COMPLETED`, `FAILED`, `CANCELED`. |
| `total` | integer \| null | yes | — |
| `processed` | integer | yes | — |
| `failed` | integer | yes | — |
| `error` | string \| null | yes | — |
| `created_at` | string | yes | — |
| `completed_at` | string \| null | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | A page of jobs. |
| 401 | Missing or invalid API key. |
| 403 | The key can read no job kind. |
| 422 | A bad `status`, `kind` or pagination param, or an unknown query key. |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/jobs' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "job",
      "id": "id_123",
      "kind": "string",
      "status": "QUEUED",
      "total": 1,
      "processed": 0,
      "failed": 0,
      "error": "string",
      "created_at": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/get-jobs
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json