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
        • GETGet all residents
        • POSTCreate resident
        • GETGet a resident by ID
        • PUTUpdate resident
        • POSTCreate resident pet
        • PUTUpdate resident pet
        • GETGet all resident insurance
        • GETGet resident insurance by ID
        • GETGet rentable items for a resident
    • CRM Generic APIs
    • PMS APIs
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
PMS Generic APIsResidents

Get a resident by ID

GET
/v1/residents/:id
GET
/v1/residents/:id
$curl https://api.propexo.com/v1/residents/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    "id": "a3f47b9e-8c2d-4f3a-9b7e-1d2f3c4e5b6a",
13    "created_at": "2023-11-10T09:15:00Z",
14    "updated_at": "2024-05-20T16:45:00Z",
15    "last_seen": "2024-05-19T12:00:00Z",
16    "x_id": "EXT-RES-987654",
17    "address_1_alternate": "123 Maple Ave Apt 4B",
18    "address_1": "456 Oak Street",
19    "address_2_alternate": "Building 2",
20    "address_2": "Unit 12",
21    "balance_in_cents": 25000,
22    "city_alternate": "Springfield",
23    "city": "Greenville",
24    "country_alternate": "USA",
25    "country": "USA",
26    "custom_data": {},
27    "date_of_birth": "1985-04-23",
28    "email_1": "jane.doe@example.com",
29    "email_2": "jane.secondary@example.com",
30    "first_name": "Jane",
31    "is_employee": false,
32    "last_name": "Doe",
33    "late_balance_in_cents": 5000,
34    "middle_name": "A",
35    "notes": "Prefers email communication. Allergic to cats.",
36    "phone_1_type": "MOBILE",
37    "phone_1": "+1-555-123-4567",
38    "phone_2_type": "WORK",
39    "phone_2": "+1-555-765-4321",
40    "state_alternate": "IL",
41    "state": "CA",
42    "zip_alternate": "62704",
43    "zip": "90210",
44    "pets": [
45      {
46        "id": "pet-78910",
47        "created_at": "2023-01-15T10:00:00Z",
48        "updated_at": "2024-04-10T11:30:00Z",
49        "last_seen": "2024-05-18T14:00:00Z",
50        "x_id": "EXT-PET-4567",
51        "name": "Buddy",
52        "type": "Dog",
53        "breed": "Golden Retriever",
54        "gender_raw": "Male",
55        "age_in_years": 3.5,
56        "weight_in_pounds": 65,
57        "is_fixed": true,
58        "is_service_animal": false,
59        "notes": "Friendly and well-trained.",
60        "custom_data": {}
61      }
62    ],
63    "vehicles": [
64      {
65        "id": "veh-45678",
66        "created_at": "2022-08-20T08:00:00Z",
67        "updated_at": "2024-03-15T09:45:00Z",
68        "last_seen": "2024-05-19T10:00:00Z",
69        "x_id": "EXT-VEH-1234",
70        "make": "Toyota",
71        "model": "Camry",
72        "color": "Blue",
73        "year": "2018",
74        "license_plate_number": "7XYZ123",
75        "license_plate_state": "CA",
76        "notes": "Parked in spot 42.",
77        "custom_data": {}
78      }
79    ],
80    "integration_id": "int-334455",
81    "integration_vendor": "APPFOLIO",
82    "property_id": "prop-998877",
83    "x_lease_id": "LEASE-123456",
84    "leases_meta_data": [
85      {
86        "lease_id": "lease-00123",
87        "x_resident_type": "Primary Tenant",
88        "resident_type_normalized": "PRIMARY",
89        "move_in_date": "2022-06-01",
90        "move_out_date": null,
91        "notice_date": null,
92        "custom_data": {},
93        "last_seen": "2024-05-19T12:00:00Z"
94      }
95    ]
96  }
97}
Get a resident by ID
Was this page helpful?
Previous

Update resident

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