List jobs

List jobs

GET/api/v1/jobs

GET /jobs
curl -X GET 'https://www.unitpost.com/api/v1/jobs' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
Response · 200
{
  "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"
    }
  ]
}

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.

Parameters5 fields
FieldTypeDescription
limitinteger · queryMax rows to return (default 20, max 100).
afterstring · queryReturn rows after this id (forward paging).
beforestring · queryReturn rows before this id (backward paging).
statusstring · queryQUEUED, RUNNING, COMPLETED, FAILED or CANCELED.
kindstring · queryOne kind, e.g. `contacts.export`, `contact_field.delete` or `contacts.topic_opt_out`.
Response · 200 fields10 fields
FieldTypeDescription
objectrequiredstring—
idrequiredstring—
kindrequiredstring—
statusrequiredenumQUEUED | RUNNING | COMPLETED | FAILED | CANCELED—
totalrequiredinteger | null—
processedrequiredinteger—
failedrequiredinteger—
errorrequiredstring | null—
created_atrequiredstring—
completed_atrequiredstring | null—
200401403422

Search docs and guides

Search the docs and product guides.