Get all properties

GEThttps://api.propexo.com/v1/properties/

Authentication

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

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=updated_at:desc

Default value: created_at:desc

updated_at_gte string | null

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

updated_at_lte string | null

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

last_seen_gte string | null

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_lte string | null

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

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0

limit integer | null

Possible values: >= 0 and <= 250

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

Default value: 100

x_id string

The external property id

x_property_id string

Deprecated: Use x_id instead

location_id string

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_id string

The Propexo integration id

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The integration vendor for the property.

is_active object

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

meta objectrequired
offsetinteger
The offset of the first result
Possible values: >= 0
Example: 0
limitinteger
The number of results to return
Possible values: >= 0 and <= 250
Example: 100
orderByobject[]required
The order of the results
hasMoreboolean | nullnullable
Whether there are more results
totalinteger
The total number of results
Possible values: >= 0
Example: 1000
results object[]required
Array [
idstringrequired
The Propexo unique identifier for the property
Example: clwktsp9v000008l31iv218hn
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_created_atnullrequired
The date the record first entered the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
x_idstringrequired
The external ID from the integration vendor
Method
properties/getProperties
Example: property123
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
properties/getProperties
Example: property123
x_building_idnullrequired
The external ID of the building (not necessarily the property) from the integration vendor
Notice
This field will always be null for ENTRATA
Example: null
building_numbernullrequired
The building number associated with the property
Notice
This field will always be null for ENTRATA
Example: null
citystring | nullnullablerequired
The city associated with the property
Method
properties/getProperties
Example: New York
codenullrequired
The code associated with the property
Notice
This field will always be null for ENTRATA
Example: null
countrystring | nullnullablerequired
The country associated with the property
Method
properties/getProperties
Example: USA
countynullrequired
The county associated with the property
Notice
This field will always be null for ENTRATA
Example: null
custom_dataobject | nullnullablerequired
is_activeboolean | nullnullablerequired
Whether the property is active. This reflects whether the property is active in the PMS. To see if a property is enabled in Propexo, please use the 'Get all my property configurations' endpoint.
Method
properties/getProperties
Example: true
manager_emailstring | nullnullablerequired
The email address of the property manager
Method
properties/getProperties
Example: [email protected]
manager_namenullrequired
The name of the property manager
Notice
This field will always be null for ENTRATA
Example: null
manager_phone_1nullrequired
The first phone number of the property manager
Notice
This field will always be null for ENTRATA
Example: null
manager_phone_1_typenullrequired
The type of the first phone number of the property manager
Notice
This field will always be null for ENTRATA
Example: null
manager_phone_2nullrequired
The second phone number of the property manager
Notice
This field will always be null for ENTRATA
Example: null
manager_phone_2_typenullrequired
The type of the second phone number of the property manager
Notice
This field will always be null for ENTRATA
Example: null
namestring | nullnullablerequired
The name of the property
Method
properties/getProperties
Example: Central Park Apartments
notesnullrequired
Notes associated with the property
Notice
This field will always be null for ENTRATA
Example: null
number_of_unitsnullrequired
The number of units in the property
Notice
This field will always be null for ENTRATA
Example: null
square_footagenullrequireddeprecated
Deprecated: Use square_feet
Notice
This field will always be null for ENTRATA
Example: null
square_feetinteger | nullnullablerequired
The square footage of the property
Notice
This field is not currently hydrated for ENTRATA
statestring | nullnullablerequired
The state associated with the property
Method
properties/getProperties
Example: NY
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Method
properties/getProperties
street_address_2nullrequireddeprecated
Deprecated: Use address_2
Notice
This field will always be null for ENTRATA
Example: null
address_1string | nullnullablerequired
The first address line associated with the property
Method
properties/getProperties
Example: 123 Central Park West
address_2nullrequired
The second address line associated with the property
Notice
This field will always be null for ENTRATA
Example: null
typestring | nullnullablerequireddeprecated
Deprecated: Use type_raw.
Method
properties/getProperties
type_rawnullrequired
The raw PMS type of the property
Notice
This field will always be null for ENTRATA
Example: null
type_normalizednullrequired
The Propexo normalized property type
Notice
This field will always be null for ENTRATA
Example: null
websitestring | nullnullablerequired
The website URL associated with the property
Method
properties/getProperties
Example: https://www.example.com
year_builtinteger | nullnullablerequired
The year the property was built
Method
properties/getProperties
Possible values: >= 0
Example: 1990
zipstring | nullnullablerequired
The zip code associated with the property
Method
properties/getProperties
Example: 10023
long_descriptionstring | nullnullablerequired
A long description of the property
Method
properties/getProperties
Example: A wonderful property with many amenities for our residents.
short_descriptionstring | nullnullablerequired
A short description of the property
Method
properties/getProperties
Example: A wonderful property.
office_hours object[]required
The office hours of the property
day_of_weekstringrequired
The day of the week associated with the office hours
Method
properties/getProperties
Show 7 enum values
SUNDAYMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAY
Example: MONDAY
open_timestringrequired
The opening time for the office
Method
properties/getProperties
Example: 08:00
close_timestringrequired
The closing time for the office
Method
properties/getProperties
Example: 15:00
Array [
day_of_weekstringrequired
The day of the week associated with the office hours
Method
properties/getProperties
Show 7 enum values
FRIDAYMONDAYSATURDAYSUNDAYTHURSDAYTUESDAYWEDNESDAY
Example: MONDAY
open_timestringrequired
The opening time for the office
Method
properties/getProperties
Example: 08:00
close_timestringrequired
The closing time for the office
Method
properties/getProperties
Example: 15:00
]
pet_types object[]required
The pet policies for the property
Array [
namestringrequired
The name associated with the pet type
Method
properties/getPetTypes
Example: Dog
is_allowednullrequired
Whether the pet type is allowed or not
Notice
This field will always be null for ENTRATA
Example: null
descriptionnullrequired
Description of the pet type
Notice
This field will always be null for ENTRATA
Example: null
notesnullrequired
Notes associated with the pet type
Notice
This field will always be null for ENTRATA
Example: null
deposit_rawnullrequired
The deposit amount associated with the pet type
Notice
This field will always be null for ENTRATA
Example: null
deposit_in_centsnullrequired
The deposit amount in cents associated with the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_rawnullrequired
The raw fee amount for the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_in_centsnullrequired
The fee amount in cents for the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_min_rawnullrequired
The minimum raw fee amount for the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_min_in_centsnullrequired
The minimum fee amount in cents for the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_max_rawnullrequired
The maxmimum raw fee amount for the pet type
Notice
This field will always be null for ENTRATA
Example: null
fee_max_in_centsnullrequired
The maxmimum raw fee amount in cents for the pet type
Notice
This field will always be null for ENTRATA
Example: null
rent_amount_rawnullrequired
The raw rent amount for the pet type
Notice
This field will always be null for ENTRATA
Example: null
rent_amount_in_centsnullrequired
The rent amount in cents for the pet type
Notice
This field will always be null for ENTRATA
Example: null
]
associated_owner_idsstring[]required
The property IDs associated with the owner
Notice
This field is not currently hydrated for ENTRATA
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum15required
The property management system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: ENTRATA
]

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

GET /v1/properties/

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

200 Successful response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "clwktsp9v000008l31iv218hn",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "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_created_at": null,
      "x_id": "property123",
      "x_property_id": "property123",
      "x_building_id": null,
      "building_number": null,
      "city": "New York",
      "code": null,
      "country": "USA",
      "county": null,
      "custom_data": "Unknown Type: object,null",
      "is_active": true,
      "manager_email": "[email protected]",
      "manager_name": null,
      "manager_phone_1": null,
      "manager_phone_1_type": null,
      "manager_phone_2": null,
      "manager_phone_2_type": null,
      "name": "Central Park Apartments",
      "notes": null,
      "number_of_units": null,
      "square_feet": 0,
      "state": "NY",
      "address_1": "123 Central Park West",
      "address_2": null,
      "type_raw": null,
      "type_normalized": null,
      "website": "https://www.example.com",
      "year_built": 1990,
      "zip": "10023",
      "long_description": "A wonderful property with many amenities for our residents.",
      "short_description": "A wonderful property.",
      "office_hours": {
        "day_of_week": "MONDAY",
        "open_time": "08:00",
        "close_time": "15:00"
      },
      "pet_types": [
        {
          "name": "Dog",
          "is_allowed": null,
          "description": null,
          "notes": null,
          "deposit_raw": null,
          "deposit_in_cents": null,
          "fee_raw": null,
          "fee_in_cents": null,
          "fee_min_raw": null,
          "fee_min_in_cents": null,
          "fee_max_raw": null,
          "fee_max_in_cents": null,
          "rent_amount_raw": null,
          "rent_amount_in_cents": null
        }
      ],
      "associated_owner_ids": [
        "string"
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "ENTRATA"
    }
  ]
}