Get jobs

get

https://api.connecteam.com/jobs/v1/jobs

Get a list of job objects relevant to instance id (scheduler id or time clock id).
If unified jobs are disabled, only schedulers are supported

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

instanceIds

array | null

List of instance IDs (schedule id or time clock id) to filter by

jobIds

array | null

List of job IDs to filter by. In cases where a job ID includes nested sub-jobs, all sub-jobs under that parent job will be retrieved alongside with the parent job. Note that this filter does not support direct querying by sub-job IDs. To retrieve specific sub-jobs, please use the Get Job endpoint

jobNames

array | null

List of job names to filter by. In case where a sub-job name is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

jobCodes

array | null

List of job codes to filter by. In case where a sub-job code is provided, the relevant sub-job with all other nested sub-jobs will be retrieved alongside with the parent job.

includeDeleted

boolean

Defaults to true

Determines whether the response includes jobs that have been deleted. Default value is set to true.

sort

string

enum

Sort key

Allowed:

order

string

enum

Defaults to asc

Sort order, set only if sort key is set

Allowed:

limit

integer

1 to 500

Defaults to 10

The maximum number of results to display per page

offset

integer

≥ 0

Defaults to 0

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error