Skip to main content

Request Body schema: application/json

integer
Unique ID for Job
string
Unique 5 digit string used to identify Job
string
Source of the Job, such as Tenant Web Form, Appfolio Plugin, Internal Web Form, Tenant Call, or API Request
string
string <date-time>
string
string <date-time>
integer
ID of current Job State
object
State object (schemas)
string
string <date-time>Date and time of the last state change
string
default:"null"
Date and time the work is scheduled to start. This, combined with scheduled_end, creates the arrival window for the Vendor.
string
default:"null"
Date and time the work is scheduled to end. This, combined with scheduled_start, creates the arrival window for the Vendor.
integer
default:"0"
1 or 0 representing if the Job is Urgent severity
integer
default:"0"
1 or 0 representing if the Job is Emergency severity
integer
default:"null"
Rating (by Tenant) of the service received
string
default:"null"
Date and time the Tenant left a Job rating
string
default:"null"
Comments added by Tenant with Job rating
string
Mutable identifier for the Job
string
Human readable name (title)
string
Long description of the problem to be solved
string
Description of problem and work to performed, specifically for the Vendor
integer
Vendor rating given by the tenant for this job
string
default:"null"
Instructions for entering the Property if the Tenant is not present. Access instructions are required to set enter_permission = 1 (see enter_permission for more information).
float
default:"null"
Cost Vendor not to exceed for the Job
float
default:"null"
Estimate amount provided by the vendor
string
default:"null"
Note provided by the vendor explaining the estimate amount
integer
default:"0"
1 or 0 representing if the Vendor has permission to enter the Property if the Tenant is not present. To set enter_permission = 1, access instructions must be included with the request, OR default_access_instructions must be set for the Job’s property (an [INHERITABLE] field).
integer
default:"0"
1 or 0 representing if the Property is vacant
integer
default:"0"
1 or 0 representing if the Job is mandatory (i.e., the Tenant cannot cancel the Job)
integer
default:"0"
1 or 0 representing if the issue needing repairs was caused by the Tenant
integer
default:"0"
1 or 0 representing if the Tenant is responsible for payment of the Job’s Invoice
integer
default:"0"
1 or 0 representing if the Job is archived. While archived, the Job will not show up in search results in the UI
string
default:"latchel"
The party currently managing the Job (“latchel” or “pm”)
integer
default:"0"
1 or 0 representing if the Vendor currently assigned to the Job can be changed
integer
default:"null"
ID referencing Tenant the Job is for
integer
ID referencing the PropertyManager in charge of Job (defaults to primary User in Property Manager Company)
string
default:"null"
Reference ID for the Job; use this field to reference the ID of a Job within a 3rd party system (with which you may be integrating).
string
default:"null"
Additional reference ID for the Job used by integrations that implement the concept of service requests
string
default:"normal"
String representing Job severity. Enum: “emergency” “urgent” “normal”
integer
default:"null"
ID referencing Issue for Job
integer
default:"null"
ID referencing Vendor assigned to Job
integer
ID referencing the Property the Job is for

Response

Return a 200 status to indicate that the data was received successfully
Last modified on May 12, 2026