Get all events

GET

/v1/events/

GET

/v1/events/

curl https://api.propexo.com/v1/events/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "orderBy": [
      {
        "field": "created_at",
        "direction": "desc"
      }
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "created_at": "2024-03-21T15:38:08.337Z",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "x_id": "evt-20240321-001",
      "x_property_id": "prop-789654123",
      "x_leasing_agent_id": null,
      "x_type_id": null,
      "x_location_id": null,
      "event_name": "Lease Renewal Reminder",
      "event_datetime": "2024-03-20T09:00:00.000Z",
      "appointment_datetime": "2024-09-04T04:35:00.000Z",
      "type_raw": "Reminder",
      "notes": "Tenant lease renewal reminder sent via email.",
      "agent_name": "Jessica Martinez",
      "reasons_for_event": "Lease expiration approaching",
      "associated_lead_ids": [
        "cm2jeb8af00042qoza7lcb5cx"
      ],
      "associated_applicant_ids": [
        "applicant-123456789"
      ],
      "associated_resident_ids": [
        "cm2jebkdu00072qozfa5p9rs7"
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI",
      "property_id": "clwi5xiix000008l6ctdgafyh"
    }
  ]
}

Get all events

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

order-bystringOptionalDefaults to created_at:desc

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

updated_at_gtestring or nullOptional

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_ltestring or nullOptional

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gtestring or nullOptional

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_ltestring or nullOptional

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offsetinteger or nullOptional>=0Defaults to 0

Can be used for paginating results

limitinteger or nullOptional0-250Defaults to 100

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

x_idstringOptional

The external ID of the event from the integration vendor

x_property_idstringOptional

The external ID of the property from the integration vendor

x_type_idstringOptional

The external ID of the type from the integration vendor

location_idstringOptional

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

property_idstringOptional

The Propexo unique identifier for the property

lead_idstringOptional

The Propexo unique identifier for the lead

applicant_idstringOptional

The Propexo unique identifier for the applicant

resident_idstringOptional

The Propexo unique identifier for the resident

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error