Skip to main content
GET
/
v1
/
batch-jobs
Get batch jobs
curl --request GET \
  --url https://gateway.app.clavata.ai:8443/v1/batch-jobs \
  --header 'Authorization: Bearer <token>'
{
  "batchJobs": [
    {
      "batchJobId": "<string>",
      "name": "<string>",
      "state": "BATCH_JOB_STATE_UNSPECIFIED",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "policyId": "<string>",
      "policyVersionId": "<string>",
      "outputFileUrl": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
batchJobIds
string[]

IDs of the batch jobs to get. If not provided, all batch jobs will be returned.

​
states
enum<string>[]

The state of the batch jobs to get. If not provided, all batch jobs will be returned.

Available options:
BATCH_JOB_STATE_UNSPECIFIED,
BATCH_JOB_STATE_ERROR,
BATCH_JOB_STATE_INITIALIZED,
BATCH_JOB_STATE_QUEUED,
BATCH_JOB_STATE_PREPROCESSING,
BATCH_JOB_STATE_PREPROCESSED,
BATCH_JOB_STATE_SUBMITTED,
BATCH_JOB_STATE_POSTPROCESSING,
BATCH_JOB_STATE_POSTPROCESSED,
BATCH_JOB_STATE_COMPLETED,
BATCH_JOB_STATE_CANCELLED

Response

A successful response.

​
batchJobs
The batch jobs · object[]