Work Orders - Propify Documentation

{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "x_id": "string",
      "x_is_deleted": [
        "boolean",
        "null"
      ],
      "x_lease_id": [
        "string",
        "null"
      ],
      "x_parent_work_order_id": [
        "string",
        "null"
      ],
      "x_property_id": "string",
      "x_resident_id": [
        "string",
        "null"
      ],
      "x_unit_id": [
        "string",
        "null"
      ],
      "x_vendor_id": [
        "string",
        "null"
      ],
      "alarm_details": [
        "string",
        "null"
      ],
      "assigned_to_id": [
        "string",
        "null"
      ],
      "assigned_to": [
        "string",
        "null"
      ],
      "building_name": [
        "string",
        "null"
      ],
      "building_number": [
        "string",
        "null"
      ],
      "category_id": [
        "string",
        "null"
      ],
      "category": [
        "string",
        "null"
      ],
      "completed_date": [
        "string",
        "null"
      ],
      "created_date": [
        "string",
        "null"
      ],
      "custom_data": {},
      "due_date": [
        "string",
        "null"
      ],
      "entry_contact_details": [
        "string",
        "null"
      ],
      "entry_contact_email": [
        "string",
        "null"
      ],
      "entry_date": [
        "string",
        "null"
      ],
      "entry_details": [
        "string",
        "null"
      ],
      "invoice_amount": [
        "number",
        "null"
      ],
      "invoice_number": [
        "string",
        "null"
      ],
      "is_floating": [
        "boolean",
        "null"
      ],
      "location_id": [
        "string",
        "null"
      ],
      "location": [
        "string",
        "null"
      ],
      "main_phone": [
        "string",
        "null"
      ],
      "permission_to_enter": [
        "boolean",
        "null"
      ],
      "pet_details": [
        "string",
        "null"
      ],
      "priority_id": [
        "string",
        "null"
      ],
      "priority": [
        "string",
        "null"
      ],
      "problem_id": [
        "string",
        "null"
      ],
      "problem": [
        "string",
        "null"
      ],
      "requested_by": [
        "string",
        "null"
      ],
      "requested_date": [
        "string",
        "null"
      ],
      "requested_from": [
        "string",
        "null"
      ],
      "scheduled_end_date": [
        "string",
        "null"
      ],
      "scheduled_start_date": [
        "string",
        "null"
      ],
      "status_id": [
        "string",
        "null"
      ],
      "status": [
        "string",
        "null"
      ],
      "sub_problem_id": [
        "string",
        "null"
      ],
      "sub_problem": [
        "string",
        "null"
      ],
      "task_title": [
        "string",
        "null"
      ],
      "unit_number": [
        "string",
        "null"
      ],
      "updated_date": [
        "string",
        "null"
      ],
      "total_cost_in_cents": [
        "number",
        "null"
      ],
      "total_time_in_minutes": [
        "number",
        "null"
      ],
      "transaction_id": [
        "string",
        "null"
      ],
      "type": [
        "string",
        "null"
      ],
      "vendor_notes": [
        "string",
        "null"
      ],
      "work_details": [
        "string",
        "null"
      ],
      "tasks": [
        {
          "id": "string",
          "x_work_order_id": [
            "string",
            "null"
          ],
          "account_id": [
            "string",
            "null"
          ],
          "description": [
            "string",
            "null"
          ],
          "employee_name": [
            "string",
            "null"
          ],
          "end_date": [
            "string",
            "null"
          ],
          "quantity": [
            "number",
            "null"
          ],
          "start_date": [
            "string",
            "null"
          ],
          "total_cost_in_cents": [
            "number",
            "null"
          ],
          "type_id": [
            "string",
            "null"
          ],
          "type": [
            "string",
            "null"
          ],
          "unit_price_in_cents": [
            "number",
            "null"
          ]
        }
      ],
      "integration_id": "string",
      "integration_vendor": "string",
      "property_id": "string"
    }
  ]
}

Query Parameters

order-by

string

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=vendor:asc,created_at:desc

offset

Default: 0

integernull

Can be used for paginating results

limit

Default: 100

integernull

A number between 1 and 250 to determine the number of results to return in a single query

x_id

string

The external work order id

x_property_id

string

The external property id

x_unit_id

string

The external unit id

x_lease_id

string

The external lease id

x_vendor_id

string

The external vendor id

x_parent_work_order_id

string

The external parent work order id

property_id

string

The Propify property id

integration_id

string

The Propify integration id

integration_vendor

string

The integration vendor for the work order.

Response

metarequired

object

resultsrequired

array

idrequired

string

The Propify unique identifier for the work order

created_atrequired

string

The date record first entered Propify

updated_atrequired

string

The date record was last updated in Propify

x_idrequired

string

The external ID from the integration vendor

x_is_deletedrequired

boolean | null

Indicates if the integration vendor has marked the record as deleted

x_lease_idrequired

string | null

The external ID of the lease from the integration vendor

x_parent_work_order_idrequired

string | null

The external ID from the integration vendor of the parent work order in cases where work orders have children

x_property_idrequired

string

The external ID of the property from the integration vendor

x_resident_idrequired

string | null

The external ID of the resident from the integration vendor

x_unit_idrequired

string | null

The external ID of the unit from the integration vendor

x_vendor_idrequired

string | null

The external ID of the vendor from the integration vendor

alarm_detailsrequired

string | null

The details of the alarm in the unit

assigned_to_idrequired

string | null

The ID of the person assigned to the work order

assigned_torequired

string | null

The name of the person assigned to the work order

building_namerequired

string | null

The building name

building_numberrequired

string | null

The building number

category_idrequired

string | null

The category ID of the work order

categoryrequired

string | null

The category of the work order

completed_daterequired

string | null

The date the work order was completed

created_daterequired

string | null

The date the work order was created

custom_datarequired

object | null

Custom data

due_daterequired

string | null

The date the work order is due

entry_contact_detailsrequired

string | null

The details of the person to contact for entry

entry_contact_emailrequired

string | null

Email address of the person to contact for entry

entry_daterequired

string | null

The date the unit was entered by the repair person

entry_detailsrequired

string | null

The details of entry into the unit

invoice_amountrequired

number | null

The invoice amount of the work order

invoice_numberrequired

string | null

The invoice number of the work order

is_floatingrequired

boolean | null

Whether the work order is floating

location_idrequired

string | null

The location ID of the work order

locationrequired

string | null

The location of the work order

main_phonerequired

string | null

Phone number

permission_to_enterrequired

boolean | null

The permission to enter the unit

pet_detailsrequired

string | null

The details of the pets in the unit

priority_idrequired

string | null

The priority ID of the work order

priorityrequired

string | null

The priority of the work order

problem_id

string | null

The problem category ID of the work order

problem

string | null

The problem category of the work order

requested_byrequired

string | null

The name of the person who requested the work order

requested_daterequired

string | null

The date/time that the requestor prefers to have the work done

requested_fromrequired

string | null

The method for how the work order was requested

scheduled_end_daterequired

string | null

The date the work is scheduled to end

scheduled_start_daterequired

string | null

The date the work is scheduled to start

status_idrequired

string | null

The status ID of the work order

statusrequired

string | null

The status of the work order

sub_problem_id

string | null

The problem sub category ID of the work order

sub_problem

string | null

The problem sub category of the work order

task_titlerequired

string | null

The title of the work order task

unit_numberrequired

string | null

The unit number

updated_daterequired

string | null

The date the work order was last updated

total_cost_in_centsrequired

number | null

The total cost of the work order

total_time_in_minutesrequired

number | null

The total time of the work order

transaction_idrequired

string | null

The transaction ID of the work order

typerequired

string | null

The type of the work order

vendor_notesrequired

string | null

The notes from the vendor

work_detailsrequired

string | null

The work details of the work order

tasksrequired

array | null

The tasks of the work order

integration_idrequired

string

The Propify unique identifier for the integration

integration_vendorrequired

string

The property management system of record

property_idrequired

string

The Propify unique identifier for the property

API Reference

​Query Parameters

​Response

Query Parameters

Response