For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all properties
        • GETGet a property by ID
        • PUTUpdate Property: Propertyware
        • POSTCreate Property: Propertyware
        • POSTCreate Property File: Propertyware
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Propertyware SOAPProperties

Get a property by ID

GET
/v1/properties/:id
GET
/v1/properties/:id
$curl https://api.propexo.com/v1/properties/id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json"
1{
2  "meta": {
3    "orderBy": [
4      {}
5    ],
6    "offset": 0,
7    "limit": 100,
8    "hasMore": true,
9    "total": 1000
10  },
11  "results": {
12    "address_1": "123 Main St",
13    "address_2": "Suite 400",
14    "associated_owner_ids": [
15      "cm22cddpn4040140560i3ijyc1a8u1eh"
16    ],
17    "building_number": null,
18    "city": "Boston",
19    "code": null,
20    "country": "US",
21    "county": "Suffolk",
22    "created_at": "2024-03-21T15:38:08.337Z",
23    "custom_data": {},
24    "id": "clwktsp9v000008l31iv218hn",
25    "integration_id": "clwh5u07w000508me66sfh3um",
26    "integration_vendor": "PROPERTYWARE",
27    "is_active": true,
28    "last_seen": "2024-03-22T10:59:45.119Z",
29    "long_description": null,
30    "manager_email": "jane.doe@propertymanagement.com",
31    "manager_name": "Jane Doe",
32    "manager_phone_1": "+1-617-555-1234",
33    "manager_phone_1_type": "WORK",
34    "manager_phone_2": "+1-617-555-5678",
35    "manager_phone_2_type": "MOBILE",
36    "name": "Downtown Boston Apartments",
37    "notes": "Recently renovated lobby and common areas.",
38    "number_of_units": null,
39    "office_hours": [],
40    "pet_types": [],
41    "property_id": "clwi5xiix000008l6ctdgafyh",
42    "short_description": null,
43    "square_feet": null,
44    "state": "MA",
45    "type_normalized": "MULTI_FAMILY",
46    "type_raw": "Apartment Complex",
47    "updated_at": "2024-03-22T10:59:45.119Z",
48    "website": "https://www.downtownbostonapartments.com",
49    "x_building_id": null,
50    "x_created_at": null,
51    "x_id": "PW-EXT-987654321",
52    "x_property_id": "PW-PROP-123456789",
53    "year_built": null,
54    "zip": "02116",
55    "square_footage": null,
56    "street_address_1": null,
57    "street_address_2": null,
58    "type": null
59  }
60}
Get a property by ID
Was this page helpful?
Previous

Update Property: Propertyware

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
The ID of the resource.

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

Response

Successful response
metaobject
resultsobject

Errors

400
Bad Request Error