Jobs

List jobs

Returns all async jobs for the workspace. Filter by list_id to see only jobs for a specific list.

get/workspaces/{workspace_id}/jobs

Request

  • Base URL: https://api.compelling.ai/v1
  • URL: https://api.compelling.ai/v1/workspaces/{workspace_id}/jobs
  • Auth: HTTP bearer

Query parameters

list_idstring

Filter jobs by list.

status'pending' | 'running' | 'complete' | 'failed'

Filter by status.

pageinteger
sizeinteger

Response

OK

Example response

{
  "data": [
    {
      "job_id": "job_01HX",
      "status": "running",
      "type": "contact_generation",
      "list_id": "lst_01HX"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 25,
    "total": 342,
    "total_pages": 14
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.