AIairbytehq
public_jobs
public
Jobs

List Jobs by sync type

Changed on
get/jobs

Request

  • Base URL
    https://api.airbyte.com/v1
  • URL
    https://api.airbyte.com/v1/jobs
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: /applications/token

Query parameters

connectionIdstring UUID

Filter the Jobs by connectionId.

limitinteger

Set the limit on the number of Jobs returned. The default is 20 Jobs.

offsetinteger

Set the offset to start at when returning Jobs. The default is 0.

jobType'sync' | 'reset' | 'refresh' | 'clear'

Enum that describes the different types of jobs that the platform runs.

Filter the Jobs by jobType.

workspaceIdsstring[]

The UUIDs of the workspaces you wish to list jobs for. Empty list will retrieve all allowed workspaces.

status'pending' | 'queued' | 'running' | 'incomplete' | 'failed' | 'succeeded' | 'cancelled'

The Job status you want to filter by

createdAtStartstring date-time

The start date to filter by

createdAtEndstring date-time

The end date to filter by

updatedAtStartstring date-time

The start date to filter by

updatedAtEndstring date-time

The end date to filter by

orderBystring

The field and method to use for ordering

Response

List all the Jobs by connectionId.

previousstring
nextstring

Example response

{
  "next": "https://api.airbyte.com/v1/jobs?limit=5&offset=10",
  "previous": "https://api.airbyte.com/v1/jobs?limit=5&offset=0",
  "data": [
    {
      "id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826",
      "status": "running",
      "jobType": "sync",
      "startTime": "2023-03-25T01:30:50Z"
    }
  ]
}

Changes

  • 7910792296fdRevision changes
    • warning

      added the new queued enum value to the // response property for the response status

    • info

      added the new enum value queued to the query request parameter status