v6

OpenAPI 3.1.02026-08-0331136162.2 KB

Property

List residents for a property

Returns a paginated list of residents for a property.

get/v1/property/{property_id}/residents

Path parameters

property_idstring required

Query parameters

limitinteger

Number of residents to return (max 500)

offsetinteger

Number of residents to skip

Response

Successful Response

idstring required

Unique identifier for the resident (UUID)

first_namestring required

Resident's first name

middle_namestring

Resident's middle name

last_namestring required

Resident's last name

emailstring

Resident's primary email address

created_atstring date-time required

When this resident record was created

created_bystring required

ID of user or system that created this record

updated_atstring date-time required

When this resident record was last modified

updated_bystring required

ID of user or system that last updated this record

deleted_atstring date-time

When this resident was soft-deleted (null if active)

Example response

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "first_name": "Emma",
    "middle_name": "Rose",
    "last_name": "Johnson",
    "email": "emma.johnson@example.com",
    "phone_numbers": [
      {
        "type": "CELL",
        "number": "+14155552671",
        "is_primary": true
      },
      {
        "type": "WORK",
        "number": "+14155552672",
        "is_primary": false
      }
    ],
    "created_at": "2023-12-15T10:30:00Z",
    "created_by": "usr_12345",
    "updated_at": "2024-01-01T14:20:00Z",
    "updated_by": "usr_12345"
  }
]