v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Lone Worker

Get jobs

Retrieves all jobs in your organization.

get/loneworker/v1/jobs

Query parameters

page_sizeinteger required

The number of results to return per page.

page_tokenstring

The token for the page of results to retrieve.

filter.searchstring

The key words to search for.

filter.statusesstring[]

The list of job statuses to filter by.

  • JOB_STATUS_ACTIVE_OK: The job is active and operating normally.
  • JOB_STATUS_OVERTIME: The job has exceeded the expected duration due to time expiry or missed check-in.
  • JOB_STATUS_IN_PANIC: The job is in a panic state.
  • JOB_STATUS_FINISHED: The job has finished.
filter.started_at.fromstring date-time

The start time for the date range.

filter.started_at.tostring date-time

The end time for the date range.

filter.group_idsstring[]

The list of group IDs to filter by.

filter.user_idsstring[]

The list of user IDs to filter by.

filter.job_idsstring[]

The list of job IDs to filter by.

Response

A successful response.

next_page_tokenstring

The token for the next page of results.

total_countinteger

The total number of jobs that match the filter.