website logo
⌘K
Getting Started
What is TIDY?
Getting Started: Rental Properties
Getting Started: Employer Benefits
Getting Started: Residential Homes
Getting Started: Offices
Dashboard
TIDY AI
Acceptance Probability
Teams & Users
Users
Teams
Properties/Addresses
Access Instructions
Jobs
Add or Request a Job
View, Edit, or Cancel Jobs
Setting Backup Times
Job Links
Job Reviews or Feedback
Resolving Pro Cancellations
Account Settings
Messages
Notifications
Plans
Access Control / Smartlocks
My Pros
Booking Different Type Of Services With Your Pros
Private Cleaning Payment
Defining your Job Request Strategy
To-Do Lists
Video Introductions
To-Do List Links
To-Dos
Do-Nots
Remote Inspections
Custom Fields
Laundry or Linens
Supply Preferences
Integrations
Automatic Booking
Billing, Pricing, & Payments
Billing History
Sending Payments
Bills & Payment Methods
Team Billing
View & Edit Prices
Viewing Billing History
Tips
Refunds
Rebate Program
Tax Reporting for Payments to Pros
Compliance, Ratings, Safety, Insurance, & Protection
Insurance or Custom Requirements
Certifications & Ratings
Satisfaction Guarantee, Disputes, & Protection
Damage Claims
Property Maps
Maintenance
Inventory Tracking
Inspections
Smart Thermostats
Issue Tracking
Automatic Translation
Other Questions
TIDY Concierge
Reports
Accounting
Developers
API Introduction
Authentication
Changelog
Errors
API Reference
Webhooks
Best Practices
Docs powered by archbee 

Create a Job

2min
POST

Creates a Job.

To create a Job you must enter a start_no_earlier_than and end_no_later_than attribute. This represents the range of times you want a pro to accept your request to complete a service.

Another optional attribute is the preferred_start_datetime. This attribute means the specific time you want for your job, if its possible. If this time is not available, then TIDY will try any other time in the range you set for start_no_earlier_than and end_no_later_than. Unless you have a strong preference, we recommend selecting the time as early as possible in your range of times. This gives more time to resolve any issues, should one occur.

The preferred_start_datetime must within the start_date_no_earlier_than and end_no_later_than.

The start_date_no_earlier_than date must be within 6 days of the end_no_later_than date.

If the preferred_start_datetime is not given, it will be filled by the start_date_no_eaelier_than.

AUTHENTICATION
Authorization
string
Bearer
BODY PARAMETERS
body
object
address_id
integer
*
to_do_list_id
integer
The id for the to-do list. Learn more: https://help.tidy.com/to-do-lists If you pass a to-do list id: The pro will see that list when doing the job. If you pass this parameter with an null value: The pro will not see any to-dos in this job. If you don't pass this parameter at all: We will use the default to-do list on your account.
service_type_key
string<regular_cleaning.one_hour | regular_cleaning.two_and_a_half_hours | regular_cleaning.four_hours>
*
Service Type key of Job. This will identify the service_type and how many hours the job will have
end_no_later_than
object
*
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.
start_no_earlier_than
object
*
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.
preferred_start_datetime
object
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. If this parameter is not given, it will be filled by the `start_date_no_eaelier_than`.
RESPONSES
201
Created
Job
# About Jobs These are the requested jobs for a specific address. Jobs can be in a couple of statuses, and they can be scheduled for confirmed times or pending acceptance from a Pro. # More details about a Job | Attribute | Description | | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | address_id | The Address to which the Job belongs to. | | to_do_list_id | The ToDoList to which the Job belongs to. It's optional | | status | The status of the Job.
**scheduled** - The default value when a Job is created.
**in_progress** - When the provider(Homekeeper) started the Job.
**completed** - Job was completed with at least one Homekeeper.
**failed** - When the provider(Homekeeper) didn't the Job. | | price | Amount in cents Ex. 1000 -> $10.00. | | is_partially_completed | True or False. When Job has more than one Homekeeper and one Homekeeper makerd the Job as happened. | | cancelled_by | Who cancelled the Job.
**null** - When noone cancelled the Job.
**customer** - When the customer cancelled.
**provider** - When the provider (Homekeeper for example) cancelled. | | service_type_key | Service Type key of Job. This will identify the service_type and how many hours the job will have.
**regular_cleaning.one_hour** - The service_type is *regular_cleaning* with *one hour*.
**regular_cleaning.two_and_a_half_hours** - The service_type is *regular_cleaning* with *two and half hour*.
**regular_cleaning.four_hours** - The service_type is *regular_cleaning* with *four hours*. | url | This is a link to the `Job` in the TIDY console/app, with the ability to take further action. | current_start_datetime.date | The current Date for the Job. | | current_start_datetime.time | The current Time for the Job. | | preferred_start_datetime.date | The preferred Date used to try to create a Job. | | preferred_start_datetime.time | The preferred Time used to try to create a Job. | | start_no_earlier_than.date | Earliest date a Job can be scheduled to start. | | start_no_earlier_than.time | Earliest time a Job can be scheduled to start. | | end_no_later_than.date | Latest date a Job can be scheduled to finish. | | end_no_later_than.time | Latest time a Job can be scheduled to finish. | created_at | Date and time of when the `Job` was created. UTC and ISO formatted | |
object
string
*
Type of object being returned
id
integer
*
address_id
integer
*
to_do_list_id
integer
*
The id for the to-do list from an account. If you enter a list id here, the pro will see the list when doing the job. You create and edit to-do lists in the console. Learn more about to-do lists here: https://help.tidy.com/to-do-lists If you pass a to-do list id: The pro will see that list when doing the job. If you pass this parameter with an null value: The pro will not see any to-dos in this job. When creating, if you don't pass this param at all, we will use the default value for your account. When updating, if you don't pass this param at all, we won't make any changes to the value.
status
string<scheduled | in_progress | completed | cancelled | failed>
*
The Status of the Job
price
integer
*
Amount in cents Ex. 1000 -> $10.00
is_partially_completed
boolean
*
cancelled_by
string<customer | pro | >
*
Who cancelled the `Job`
service_type_key
string<regular_cleaning.one_hour | regular_cleaning.two_and_a_half_hours | regular_cleaning.four_hours>
*
Service Type key of Job. This will identify the service_type and how many hours the job will have
url
string
*
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
*
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
*
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
*
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
*
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
*
Date and time of when the `Job` was created. UTC and ISO formatted




Updated 26 Apr 2023
Did this page help you?
Yes
No
PREVIOUS
List all Jobs
NEXT
Update a Job
Docs powered by archbee