Jobs

Create a job

Request a new cleaning or maintenance job

post/jobs

Request

  • Base URL: https://api.tidy.com/v1
  • URL: https://api.tidy.com/v1/jobs
  • Auth: API key in header X-API-Key

Request body

address_idinteger required
pro_idinteger

Optional: assign a specific pro

service_type'cleaning' | 'maintenance' | 'inspection' | 'restocking' required
scheduled_atstring date-time required
pricenumber float
notesstring

Response

Job created successfully

idinteger

Unique job identifier

address_idinteger

The address where the job will be performed

pro_idinteger nullable

The pro assigned to this job

service_type'cleaning' | 'maintenance' | 'inspection' | 'restocking'

Type of service

status'pending' | 'confirmed' | 'in_progress' | 'completed' | 'cancelled'
scheduled_atstring date-time

When the job is scheduled to start

completed_atstring date-time nullable
pricenumber float

Job price in USD

notesstring nullable

Additional notes for the pro

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.