ESescape
Jobs
Beta

List jobs

List jobs of the organization with optional filtering by kind and status.

get/jobs

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'CREATED_AT' | 'SCHEDULED_AT'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

kindsstring[]

Filter by job kinds.

statusesstring[]

Filter by job statuses.

searchstring

Case-insensitive substring match on the job kind. Use the kinds filter for exact kinds; report names are not searchable.

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20
}

Changes

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