Custom objects

Everything your organization added beyond leads, accounts and deals: properties, trips, appointments, engagements.

1 min readUpdated 15 Oct 2026API v1

Properties and units for real estate, trips for travel, appointments for clinics, engagements for a CA firm. Address an object by its slug (site_visit, appointment) or its id.

List your objects#

GET/objectsrecords:read

Your organization’s objects, with each one’s fields (key, label, fieldType, options) and stages.

Records#

GET/objects/{object}/recordsrecords:read

POST/objects/{object}/recordsrecords:write

GET/objects/{object}/records/{id}records:read

PATCH/objects/{object}/records/{id}records:write

Record shape#

A record is { "stage", "assignedTo", "data": { … } }, with field values under data by field key. Lookups take the linked record’s id. Send date fields as plain calendar dates.

Totals your object rolls up (a trip’s margin, an engagement’s billable hours) are calculated by Worxley and ignored if you send them.

POST /objects/site_visit/records

{
  "stage": "scheduled",
  "data": {
    "visitor": "Rohit Mehta",
    "project": "6a4c3a85c01de391daf2b801",
    "visit_date": "2026-10-18"
  }
}