# List all jobs.

Endpoint: GET /jobs
Version: 3.30.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Query parameters:

  - `limit` (integer)
    Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

  - `cursor` (string)
    Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

  - `sort` (string)
    The field to sort results by. A property name with a prepended '-' signifies descending order.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `items` (array)

  - `items.id` (string)
    The Job entity ID.
    Example: job-123

  - `items.status` (string)
    The status of the job.
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `items.is_waiting_for_telemetry` (boolean)
    Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.

  - `items.type` (string)
    The type of job being done.
    Example: DB_REFRESH

  - `items.localized_type` (string)
    The i18n translated type of job being done.
    Example: DB Refresh

  - `items.error_details` (string)
    Details about the failure for FAILED jobs.
    Example: Unable to connect to the engine.

  - `items.warning_message` (string)
    Warnings for the job.
    Example: Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.

  - `items.target_id` (string)
    A reference to the job's target.
    Example: vdb-123

  - `items.target_name` (string)
    A reference to the job's target name.
    Example: vdb

  - `items.work_source_id` (string)
    The ID of the entity that initiated this job (e.g. a policy ID), if applicable.

  - `items.work_source_name` (string)
    The name of the entity that initiated this job, if applicable.

  - `items.work_source_type` (string)
    The origin of the operation that created this job. Null for DCT-initiated operations (attributed via account_id). DIRECT means the action was performed directly on the engine, bypassing DCT; POLICY means an automated policy triggered it; SYSTEM means it was engine-internal.
    Enum: "DIRECT", "POLICY", "SYSTEM"

  - `items.start_time` (string)
    The time the job started executing.
    Example: 2022-01-02T05:11:24.148Z

  - `items.update_time` (string)
    The time the job was last updated.
    Example: 2022-01-02T06:11:24.148Z

  - `items.trace_id` (string)
    traceId of the request which created this Job

  - `items.engine_ids` (array)
    IDs of the engines this Job is executing on.

  - `items.tags` (array)

  - `items.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `items.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `items.engines` (array)

  - `items.engines.engine_id` (string)

  - `items.engines.engine_name` (string)

  - `items.account_id` (integer)
    The ID of the account who initiated this job.
    Example: 1

  - `items.account_name` (string)
    The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-.
    Example: User 1

  - `items.compliance_node_id` (string)
    The ID of the associated compliance node, if applicable.

  - `items.compliance_node_name` (string)
    The name of the associated compliance node, if applicable.

  - `items.percent_complete` (integer)
    Completion percentage of the Job.
    Example: 50

  - `items.virtualization_tasks` (array)

  - `items.virtualization_tasks.id` (string)

  - `items.virtualization_tasks.parent_job_id` (string)

  - `items.virtualization_tasks.start_time` (string)

  - `items.virtualization_tasks.end_time` (string)

  - `items.virtualization_tasks.title` (string)

  - `items.virtualization_tasks.percent_complete` (integer)

  - `items.virtualization_tasks.events` (array)

  - `items.virtualization_tasks.events.message_details` (string)

  - `items.virtualization_tasks.events.message_action` (string)

  - `items.virtualization_tasks.events.message_command_output` (string)

  - `items.virtualization_tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `items.tasks` (array)

  - `items.tasks.id` (string)

  - `items.tasks.parent_job_id` (string)

  - `items.tasks.start_time` (string)

  - `items.tasks.end_time` (string)

  - `items.tasks.title` (string)

  - `items.tasks.percent_complete` (integer)

  - `items.tasks.events` (array)

  - `items.tasks.events.message_details` (string)

  - `items.tasks.events.message_action` (string)

  - `items.tasks.events.message_command_output` (string)

  - `items.tasks.events.timestamp` (string)
    When this specific event occurred. Absent/null for events persisted before this field was added (no backfill) and for any producer not yet updated to set it.

  - `items.tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `items.execution_id` (string)
    The ID of the associated masking execution, if any.

  - `items.result_type` (string)
    The type of the job result. This is the type of the object present in the result.

  - `items.result` (object)
    The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.

  - `items.parent_job_id` (string)
    The ID of the parent job, if this job was triggered by another job.

  - `errors` (array)
    Sadly, sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. The Errors object contains information about full or partial failures which might have occurred during the request.

  - `errors.message` (string)
    Message providing more detail about the error that occurred, if available.

  - `errors.object_name` (string)
    Name of the object affected by the error.

  - `response_metadata` (object)

  - `response_metadata.prev_cursor` (string)
    Pointer to the previous page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.next_cursor` (string)
    Pointer to the next page of results. Use this value as a cursor query parameter in a subsequent request, along with limit, to navigate through the collection by virtual page.

  - `response_metadata.total` (integer)
    The total number of results. This value may not be provided.