Retrieve a list of jobs

get

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

Retrieves a list of jobs that meet the specified criteria.

Query Params

recurring_booking

string

Get all jobs that are part of a recurring series by passing the ID of the recurring booking.

assigned

string

Provide the team member ID to filter jobs assigned to a specific service provider.

sort_by

string

enum

Can bestart_time or creation_date. Defaults to start_time

Allowed:

sort_order

string

enum

If empty, defaults to ascending

Allowed:

created_before

date-time

Returns jobs created before this datetime

created_after

date-time

Returns jobs created after this datetime

start_date_min

date-time

Filter jobs scheduled to start on or after a datetime

start_date_max

date-time

Filter jobs scheduled to start on or before a datetime

canceled

boolean

Filter jobs that have been canceled. Pass true to only return canceled jobs. Pass false to only return uncanceled jobs.

status

string

enum

Returns jobs with matching job status.

Allowed:

customer

string

The ID of the customer to return jobs for.

territory

string

Filter jobs based on the ID of the service territory.

cursor

int32

Defaults to 0

Pagination start

limit

int32

Defaults to 20

The maximum number of results to return. If not specified, defaults to 20. Max is 100.

Responses

Language

Credentials

Header

Response

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

application/json

200200

400400