Get a resident by ID | Propexo

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

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "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_id": "customer321",
    "address_1_alternate": "456 Oak St",
    "address_1": "123 Main St",
    "address_2_alternate": "789 Pine St",
    "address_2": "456 Oak St",
    "balance_in_cents": null,
    "city_alternate": "Shelbyville",
    "city": "Springfield",
    "country_alternate": "US",
    "country": "US",
    "custom_data": {},
    "date_of_birth": "1980-01-01T00:00:00Z",
    "email_1": "john.doe@example.com",
    "email_2": "j.doe@work.com",
    "first_name": "John",
    "is_employee": true,
    "last_name": "Doe",
    "late_balance_in_cents": null,
    "middle_name": "Michael",
    "notes": null,
    "phone_1_type": "HOME",
    "phone_1": "(123) 456-7890",
    "phone_2_type": "MOBILE",
    "phone_2": "(098) 765-4321",
    "state_alternate": "MO",
    "state": "IL",
    "zip_alternate": "62705",
    "zip": "62704",
    "pets": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "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_id": "pet123",
        "name": "Buddy",
        "type": "Dog",
        "breed": "Labrador",
        "gender_raw": "M",
        "age_in_years": 3,
        "weight_in_pounds": 60,
        "is_fixed": null,
        "is_service_animal": true,
        "notes": null,
        "custom_data": {}
      }
    ],
    "vehicles": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "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_id": "vehX123",
        "make": "Toyota",
        "model": "Camry",
        "color": "Red",
        "year": "2020",
        "license_plate_number": "ABC1234",
        "license_plate_state": "CA",
        "notes": null,
        "custom_data": {}
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "ENTRATA",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "x_lease_id": "string",
    "leases_meta_data": [
      {
        "lease_id": "clxkwuk5d000at3oz3b008unk",
        "x_resident_type": "main",
        "resident_type_normalized": "PRIMARY",
        "move_in_date": "2023-06-15T00:00:00Z",
        "move_out_date": "2024-06-15T00:00:00Z",
        "notice_date": null,
        "custom_data": {},
        "last_seen": "2024-03-22T10:59:45.119Z"
      }
    ]
  }
}

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

{
  "meta": {
    "orderBy": [
      {}
    ],
    "offset": 0,
    "limit": 100,
    "hasMore": true,
    "total": 1000
  },
  "results": {
    "id": "clwktsp9v000008l31iv218hn",
    "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_id": "customer321",
    "address_1_alternate": "456 Oak St",
    "address_1": "123 Main St",
    "address_2_alternate": "789 Pine St",
    "address_2": "456 Oak St",
    "balance_in_cents": null,
    "city_alternate": "Shelbyville",
    "city": "Springfield",
    "country_alternate": "US",
    "country": "US",
    "custom_data": {},
    "date_of_birth": "1980-01-01T00:00:00Z",
    "email_1": "john.doe@example.com",
    "email_2": "j.doe@work.com",
    "first_name": "John",
    "is_employee": true,
    "last_name": "Doe",
    "late_balance_in_cents": null,
    "middle_name": "Michael",
    "notes": null,
    "phone_1_type": "HOME",
    "phone_1": "(123) 456-7890",
    "phone_2_type": "MOBILE",
    "phone_2": "(098) 765-4321",
    "state_alternate": "MO",
    "state": "IL",
    "zip_alternate": "62705",
    "zip": "62704",
    "pets": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "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_id": "pet123",
        "name": "Buddy",
        "type": "Dog",
        "breed": "Labrador",
        "gender_raw": "M",
        "age_in_years": 3,
        "weight_in_pounds": 60,
        "is_fixed": null,
        "is_service_animal": true,
        "notes": null,
        "custom_data": {}
      }
    ],
    "vehicles": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "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_id": "vehX123",
        "make": "Toyota",
        "model": "Camry",
        "color": "Red",
        "year": "2020",
        "license_plate_number": "ABC1234",
        "license_plate_state": "CA",
        "notes": null,
        "custom_data": {}
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "ENTRATA",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "x_lease_id": "string",
    "leases_meta_data": [
      {
        "lease_id": "clxkwuk5d000at3oz3b008unk",
        "x_resident_type": "main",
        "resident_type_normalized": "PRIMARY",
        "move_in_date": "2023-06-15T00:00:00Z",
        "move_out_date": "2024-06-15T00:00:00Z",
        "notice_date": null,
        "custom_data": {},
        "last_seen": "2024-03-22T10:59:45.119Z"
      }
    ]
  }
}

Get a resident by ID

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

updated_at_gtestring or nullOptional

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

updated_at_ltestring or nullOptional

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

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

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

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 0,
7	"limit": 100,
8	"hasMore": true,
9	"total": 1000
10	},
11	"results": {
12	"id": "clwktsp9v000008l31iv218hn",
13	"created_at": "2024-03-21T15:38:08.337Z",
14	"updated_at": "2024-03-22T10:59:45.119Z",
15	"last_seen": "2024-03-22T10:59:45.119Z",
16	"x_id": "customer321",
17	"address_1_alternate": "456 Oak St",
18	"address_1": "123 Main St",
19	"address_2_alternate": "789 Pine St",
20	"address_2": "456 Oak St",
21	"balance_in_cents": null,
22	"city_alternate": "Shelbyville",
23	"city": "Springfield",
24	"country_alternate": "US",
25	"country": "US",
26	"custom_data": {},
27	"date_of_birth": "1980-01-01T00:00:00Z",
28	"email_1": "john.doe@example.com",
29	"email_2": "j.doe@work.com",
30	"first_name": "John",
31	"is_employee": true,
32	"last_name": "Doe",
33	"late_balance_in_cents": null,
34	"middle_name": "Michael",
35	"notes": null,
36	"phone_1_type": "HOME",
37	"phone_1": "(123) 456-7890",
38	"phone_2_type": "MOBILE",
39	"phone_2": "(098) 765-4321",
40	"state_alternate": "MO",
41	"state": "IL",
42	"zip_alternate": "62705",
43	"zip": "62704",
44	"pets": [
45	{
46	"id": "clwktsp9v000008l31iv218hn",
47	"created_at": "2024-03-21T15:38:08.337Z",
48	"updated_at": "2024-03-22T10:59:45.119Z",
49	"last_seen": "2024-03-22T10:59:45.119Z",
50	"x_id": "pet123",
51	"name": "Buddy",
52	"type": "Dog",
53	"breed": "Labrador",
54	"gender_raw": "M",
55	"age_in_years": 3,
56	"weight_in_pounds": 60,
57	"is_fixed": null,
58	"is_service_animal": true,
59	"notes": null,
60	"custom_data": {}
61	}
62	],
63	"vehicles": [
64	{
65	"id": "clwktsp9v000008l31iv218hn",
66	"created_at": "2024-03-21T15:38:08.337Z",
67	"updated_at": "2024-03-22T10:59:45.119Z",
68	"last_seen": "2024-03-22T10:59:45.119Z",
69	"x_id": "vehX123",
70	"make": "Toyota",
71	"model": "Camry",
72	"color": "Red",
73	"year": "2020",
74	"license_plate_number": "ABC1234",
75	"license_plate_state": "CA",
76	"notes": null,
77	"custom_data": {}
78	}
79	],
80	"integration_id": "clwh5u07w000508me66sfh3um",
81	"integration_vendor": "ENTRATA",
82	"property_id": "clwi5xiix000008l6ctdgafyh",
83	"x_lease_id": "string",
84	"leases_meta_data": [
85	{
86	"lease_id": "clxkwuk5d000at3oz3b008unk",
87	"x_resident_type": "main",
88	"resident_type_normalized": "PRIMARY",
89	"move_in_date": "2023-06-15T00:00:00Z",
90	"move_out_date": "2024-06-15T00:00:00Z",
91	"notice_date": null,
92	"custom_data": {},
93	"last_seen": "2024-03-22T10:59:45.119Z"
94	}
95	]
96	}
97	}