{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "x_id": "string",
    "x_property_id": "string",
    "x_lead_id": "string",
    "x_leasing_agent_id": [
      "string",
      "null"
    ],
    "x_type_id": [
      "string",
      "null"
    ],
    "x_location_id": [
      "string",
      "null"
    ],
    "event_name": [
      "string",
      "null"
    ],
    "event_datetime": [
      "string",
      "null"
    ],
    "appointment_datetime": [
      "string",
      "null"
    ],
    "type_raw": [
      "string",
      "null"
    ],
    "notes": [
      "string",
      "null"
    ],
    "agent_name": [
      "string",
      "null"
    ],
    "reasons_for_event": [
      "string",
      "null"
    ],
    "integration_id": "string",
    "integration_vendor": "string",
    "property_id": "string"
  }
}

​
Path Parameters

lead_event_idrequired
string

The ID of the resource.

lead_event_idrequired
string

The ID of the resource.

​
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

​
Response

metarequired
object
resultsrequired
object