Get a property by ID

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

Authentication

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

Path parameters

id stringrequired

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=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

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
orderBy object[]required
The order of the results
Array [
object
]
hasMoreboolean | nullnullable
Whether there are more results
totalinteger
The total number of results
Possible values: >= 0
Example: 1000
results objectrequired
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_atstring | nullnullablerequired
The date the record first entered the integration vendor
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: 2023-12-12T00:00:00.000Z
x_idstringrequired
The external ID from the integration vendor
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: 3423478
x_property_idstringrequired
The external ID of the property from the integration vendor
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: 3423478
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 PROPERTYWARE_REST
Example: null
building_numbernullrequired
The building number associated with the property
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
citystring | nullnullablerequired
The city associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: Tampa
codenullrequired
The code associated with the property
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
countrystring | nullnullablerequired
The country associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: United States
countystring | nullnullablerequired
The county associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: Orange
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	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: true
manager_emailstring | nullnullablerequired
The email address of the property manager
Important
There can potentially be more than one manager for a property. In that case, the first manager is processed. If you'd like all managers, contact Propexo for custom data additions.
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: [email protected]
manager_namestring | nullnullablerequired
The name of the property manager
Important
There can potentially be more than one manager for a property. In that case, the first manager is processed. If you'd like all managers, contact Propexo for custom data additions.
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: johndoe
manager_phone_1nullrequired
The first phone number of the property manager
Notice
This field will always be null for PROPERTYWARE_REST
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 PROPERTYWARE_REST
Example: null
manager_phone_2nullrequired
The second phone number of the property manager
Notice
This field will always be null for PROPERTYWARE_REST
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 PROPERTYWARE_REST
Example: null
namestring | nullnullablerequired
The name of the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: The Green Meadows
notesnullrequired
Notes associated with the property
Important
This field is available via Propertyware SOAP, but not Propertyware REST.
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
number_of_unitsinteger | nullnullablerequired
The number of units in the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Possible values: >= 0
Example: 2
square_footageinteger | nullnullablerequireddeprecated
Deprecated: Use square_feet
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
square_feetinteger | nullnullablerequired
The square footage of the property
Notice
This field is not currently hydrated for PROPERTYWARE_REST
statestring | nullnullablerequired
The state associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: FL
street_address_1string | nullnullablerequireddeprecated
Deprecated: Use address_1
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
street_address_2string | nullnullablerequireddeprecated
Deprecated: Use address_2
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
address_1string | nullnullablerequired
The first address line associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: 131 Douglas Drive
address_2string | nullnullablerequired
The second address line associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: Suite 2
typenullrequireddeprecated
Deprecated: Use type_raw.
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
type_rawstring | nullnullablerequired
The raw PMS type of the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: APARTMENT
type_normalizedstring | nullnullablerequired
The Propexo normalized property type
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: RESIDENTIAL
Show 2 variants
• stringCOMMERCIALMULTI_FAMILYOTHERSINGLE_FAMILYSTUDENT_HOUSINGVACATION
• string
websitestring | nullnullablerequired
The website URL associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: https://www.example.com
year_builtinteger | nullnullablerequired
The year the property was built
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Possible values: >= 0
Example: 1963
zipstring | nullnullablerequired
The zip code associated with the property
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: 12722
long_descriptionnullrequired
A long description of the property
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
short_descriptionnullrequired
A short description of the property
Notice
This field will always be null for PROPERTYWARE_REST
Example: null
office_hours object[]required
The office hours of the property
Notice
This field is not currently hydrated for PROPERTYWARE_REST
day_of_weekstringrequired
The day of the week associated with the office hours
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Show 7 enum values
SUNDAYMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAY
open_timestringrequired
The opening time for the office
Notice
This field is not currently hydrated for PROPERTYWARE_REST
close_timestringrequired
The closing time for the office
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Array [
day_of_weekstringrequired
The day of the week associated with the office hours
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Show 7 enum values
FRIDAYMONDAYSATURDAYSUNDAYTHURSDAYTUESDAYWEDNESDAY
open_timestringrequired
The opening time for the office
Notice
This field is not currently hydrated for PROPERTYWARE_REST
close_timestringrequired
The closing time for the office
Notice
This field is not currently hydrated for PROPERTYWARE_REST
]
pet_types object[]required
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Array [
namestringrequired
The name associated with the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
is_allowedboolean | nullnullablerequired
Whether the pet type is allowed or not
Notice
This field is not currently hydrated for PROPERTYWARE_REST
descriptionstring | nullnullablerequired
Description of the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
notesstring | nullnullablerequired
Notes associated with the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
deposit_rawstring | nullnullablerequired
The deposit amount associated with the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
deposit_in_centsnumber | nullnullablerequired
The deposit amount in cents associated with the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Example: 100000
fee_rawstring | nullnullablerequired
The raw fee amount for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
fee_in_centsnumber | nullnullablerequired
The fee amount in cents for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Example: 100000
fee_min_rawstring | nullnullablerequired
The minimum raw fee amount for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
fee_min_in_centsnumber | nullnullablerequired
The minimum fee amount in cents for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Example: 100000
fee_max_rawstring | nullnullablerequired
The maxmimum raw fee amount for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
fee_max_in_centsnumber | nullnullablerequired
The maxmimum raw fee amount in cents for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Example: 100000
rent_amount_rawstring | nullnullablerequired
The raw rent amount for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
rent_amount_in_centsnumber | nullnullablerequired
The rent amount in cents for the pet type
Notice
This field is not currently hydrated for PROPERTYWARE_REST
Example: 100000
]
associated_owner_idsstring[]required
The property IDs associated with the owner
Method	Interface
/v1/buildings	Buildings
/v1/buildings/{buildingID}	Buildings
Example: cm22cddpn4040140560i3ijyc1a8u1eh
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum18required
The property management system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: PROPERTYWARE_REST

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/:id

curl https://api.propexo.com/v1/properties/:id \
     -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": "2023-12-12T00:00:00.000Z",
    "x_id": "3423478",
    "x_property_id": "3423478",
    "x_building_id": null,
    "building_number": null,
    "city": "Tampa",
    "code": null,
    "country": "United States",
    "county": "Orange",
    "custom_data": "Unknown Type: object,null",
    "is_active": true,
    "manager_email": "[email protected]",
    "manager_name": "johndoe",
    "manager_phone_1": null,
    "manager_phone_1_type": null,
    "manager_phone_2": null,
    "manager_phone_2_type": null,
    "name": "The Green Meadows",
    "notes": null,
    "number_of_units": 2,
    "square_feet": 0,
    "state": "FL",
    "address_1": "131 Douglas Drive",
    "address_2": "Suite 2",
    "type_raw": "APARTMENT",
    "type_normalized": "RESIDENTIAL",
    "website": "https://www.example.com",
    "year_built": 1963,
    "zip": "12722",
    "long_description": null,
    "short_description": null,
    "office_hours": {
      "day_of_week": "SUNDAY",
      "open_time": "string",
      "close_time": "string"
    },
    "pet_types": [
      {
        "name": "string",
        "is_allowed": true,
        "description": "string",
        "notes": "string",
        "deposit_raw": "string",
        "deposit_in_cents": 100000,
        "fee_raw": "string",
        "fee_in_cents": 100000,
        "fee_min_raw": "string",
        "fee_min_in_cents": 100000,
        "fee_max_raw": "string",
        "fee_max_in_cents": 100000,
        "rent_amount_raw": "string",
        "rent_amount_in_cents": 100000
      }
    ],
    "associated_owner_ids": "cm22cddpn4040140560i3ijyc1a8u1eh",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "PROPERTYWARE_REST"
  }
}