Get all properties | Propexo

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

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "address_1": "123 Main Street",
      "address_2": "Apt 1",
      "associated_owner_ids": [
        "owner12345"
      ],
      "city": "New York",
      "code": "central_park_apt",
      "created_at": "2024-03-21T15:38:08.337Z",
      "custom_data": {},
      "id": "clwktsp9v000008l31iv218hn",
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "YARDI_REST",
      "last_seen": "2024-03-22T10:59:45.119Z",
      "name": "Central Park Apartments",
      "office_hours": [
        {
          "day_of_week": "MONDAY",
          "open_time": "09:00",
          "close_time": "17:00"
        },
        {
          "day_of_week": "TUESDAY",
          "open_time": "09:00",
          "close_time": "17:00"
        },
        {
          "day_of_week": "WEDNESDAY",
          "open_time": "09:00",
          "close_time": "17:00"
        },
        {
          "day_of_week": "THURSDAY",
          "open_time": "09:00",
          "close_time": "17:00"
        },
        {
          "day_of_week": "FRIDAY",
          "open_time": "09:00",
          "close_time": "17:00"
        }
      ],
      "pet_types": [
        {
          "name": "Dog",
          "is_allowed": true,
          "description": "Dogs up to 50 lbs allowed",
          "notes": "Breed restrictions apply",
          "deposit_raw": "$300",
          "deposit_in_cents": 30000,
          "fee_raw": "$50",
          "fee_in_cents": 5000,
          "fee_min_raw": "$25",
          "fee_min_in_cents": 2500,
          "fee_max_raw": "$75",
          "fee_max_in_cents": 7500,
          "rent_amount_raw": "$30",
          "rent_amount_in_cents": 3000
        }
      ],
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "square_feet": 85000,
      "state": "NY",
      "type_normalized": "OTHER",
      "type_raw": "Residential",
      "updated_at": "2024-03-22T10:59:45.119Z",
      "x_id": "3299",
      "x_property_id": "3299",
      "zip": "10001"
    }
  ]
}

Get all properties

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

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 property id

x_property_idstringOptional

Deprecated: Use x_id instead

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.

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the property.

is_activeboolean or string or nullOptional

Active status of the property in the PMS. Please note this is a separate value to the property's status in Propexo which can be fetched using the 'Get all my property configurations' endpoint.

Response

Successful response

metaobject

resultslist of objects

Errors

400

Bad Request Error