List all Jobs

get https://api.tidy.com/api/v1/jobs

List all Jobs for an account.

Filters

You can filter Jobs using these params:

param	possible values	examples	description
address_id	`Integer`	`1` or `1,2`	filter by an `address.id`. (Use commas to filter by more than one)
status	`scheduled`, `in_progress`, `completed`, `cancelled`, `failed`	`scheduled` or `scheduled,in_progress`	filter by `status`. (Use commas to filter by more than one)
to_do_list_id	`Integer`	`1` or `1,2`	filter by an `to_do_list.id`. (Use commas to filter by more than one)

Response

Response body

object

string

required

Defaults to list

data

array of objects

data

object

string

required

Defaults to job

Type of object being returned

integer

required

Unique identifier for the Job

address_id

integer

required

Unique identifier for the Address this Job belongs to

to_do_list_id

integer | null

required

Unique identifier for the To-Do List.

status

string

required

The Status of the Job

scheduled in_progress completed cancelled failed

price

integer

required

Price of the Job in cents. Ex. 1000 -> $10.00

is_partially_completed

boolean

required

True when Job has more than one Pro and one Pro makerd the Job as completed.

cancelled_by

string | null

required

Who cancelled the Job

customer pro

service_type_key

string

required

Service Type key of Job. This will identify the service_type and how many hours the job will have

regular_cleaning.one_hour regular_cleaning.two_and_a_half_hours regular_cleaning.four_hours

url

string

required

This is a link to the Job in the TIDY console/app. If it is past, it will direct you to details about the past Job. If the Job is scheduled or ongoing, it will take you to the Job with the ability to take further action.

current_start_datetime

object

required

The current date and time that a Job is scheduled as a confirmed time with a Pro. In other words, some Pro said "I am coming at this time".

preferred_start_datetime

object

required

This is the preferred time a Pro could show up, if possible. We recommend adding the earliest possible time possible unless you have a strong preference. For example: If Monday 8:00am is the earliest a Pro could do the job, by Tuesday 11:00am is preferred, insert Tuesday 11:00am here.

start_no_earlier_than

object

required

This is the earliest a job can be scheduled for. For example: If Monday 8:00am is the earliest a Pro could do the job, insert that here.

end_no_later_than

object

required

This is the latest time a job can be finished on the property. For example: If a Pro must absolutely be gone by Friday 5:00pm, insert that here.

created_at

string

required

Date and time of when the Job was created. UTC and ISO formatted

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.tidy.com/api/v1/jobs \
3
     --header 'accept: application/json'

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

application/json

200OK