Get an applicant by ID | Propexo

curl https://api.propexo.com/v1/applicants/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "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": "ext-987654321",
    "x_property_id": "prop-123456789",
    "x_lead_id": null,
    "x_unit_id_preferred": [
      "123",
      "456"
    ],
    "address_1_alternate": null,
    "address_1": "123 Main St",
    "address_2_alternate": null,
    "address_2": "Apt 4B",
    "applications": [
      {
        "applicant_id": "clwktsp9v000008l31iv218hn",
        "application_id": "app-20240322-001",
        "status_raw": "Approved by leasing",
        "status_normalized": "APPROVED",
        "custom_data": {},
        "status": null
      }
    ],
    "city_alternate": null,
    "city": "Boston",
    "country_alternate": null,
    "country": "US",
    "custom_data": {},
    "date_of_birth": "1990-07-15",
    "email_1": "sally.jones@example.com",
    "email_2": null,
    "first_name": "Sally",
    "last_name": "Jones",
    "middle_name": null,
    "notes": null,
    "phone_1_type": "MOBILE",
    "phone_1": "(617) 555-1234",
    "phone_2_type": "FAX",
    "phone_2": "(617) 555-5678",
    "state_alternate": null,
    "state": "MA",
    "type_normalized": null,
    "type_raw": null,
    "zip_alternate": null,
    "zip": "02116",
    "pets": [
      {
        "id": "pet-001",
        "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": "ext-pet-123",
        "age_in_years": 3,
        "breed": "Golden Retriever",
        "color": "Golden",
        "gender_raw": "Female",
        "is_declawed": false,
        "is_fixed": true,
        "is_service_animal": false,
        "is_trained": true,
        "is_vaccinated": true,
        "name": "Buddy",
        "notes": "Very friendly and well-behaved",
        "type": "Dog",
        "weight_in_pounds": 65,
        "custom_data": {}
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "REALPAGE_RPX",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id_preferred": [
      "testintegration:123:123",
      "testintegration:456:456"
    ],
    "screenings": [
      {
        "id": "screen-001",
        "created_at": "2024-03-21T15:38:08.337Z",
        "last_seen": "2024-03-22T10:59:45.119Z",
        "x_id": "c5ca182e295028100d8abbcb1183197eb9455230b5fa78f4b03bc68199c0e17b",
        "status_raw": "Not screened",
        "screening_date": null
      }
    ],
    "x_unit_id": "unit-456789123",
    "x_lease_id": null,
    "self_reported_income": [
      {
        "amount_in_cents": 325000,
        "amount_raw": "$3,250.00",
        "type_normalized": null,
        "type_raw": null
      }
    ]
  }
}

curl https://api.propexo.com/v1/applicants/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "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": "ext-987654321",
    "x_property_id": "prop-123456789",
    "x_lead_id": null,
    "x_unit_id_preferred": [
      "123",
      "456"
    ],
    "address_1_alternate": null,
    "address_1": "123 Main St",
    "address_2_alternate": null,
    "address_2": "Apt 4B",
    "applications": [
      {
        "applicant_id": "clwktsp9v000008l31iv218hn",
        "application_id": "app-20240322-001",
        "status_raw": "Approved by leasing",
        "status_normalized": "APPROVED",
        "custom_data": {},
        "status": null
      }
    ],
    "city_alternate": null,
    "city": "Boston",
    "country_alternate": null,
    "country": "US",
    "custom_data": {},
    "date_of_birth": "1990-07-15",
    "email_1": "sally.jones@example.com",
    "email_2": null,
    "first_name": "Sally",
    "last_name": "Jones",
    "middle_name": null,
    "notes": null,
    "phone_1_type": "MOBILE",
    "phone_1": "(617) 555-1234",
    "phone_2_type": "FAX",
    "phone_2": "(617) 555-5678",
    "state_alternate": null,
    "state": "MA",
    "type_normalized": null,
    "type_raw": null,
    "zip_alternate": null,
    "zip": "02116",
    "pets": [
      {
        "id": "pet-001",
        "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": "ext-pet-123",
        "age_in_years": 3,
        "breed": "Golden Retriever",
        "color": "Golden",
        "gender_raw": "Female",
        "is_declawed": false,
        "is_fixed": true,
        "is_service_animal": false,
        "is_trained": true,
        "is_vaccinated": true,
        "name": "Buddy",
        "notes": "Very friendly and well-behaved",
        "type": "Dog",
        "weight_in_pounds": 65,
        "custom_data": {}
      }
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "REALPAGE_RPX",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "unit_id_preferred": [
      "testintegration:123:123",
      "testintegration:456:456"
    ],
    "screenings": [
      {
        "id": "screen-001",
        "created_at": "2024-03-21T15:38:08.337Z",
        "last_seen": "2024-03-22T10:59:45.119Z",
        "x_id": "c5ca182e295028100d8abbcb1183197eb9455230b5fa78f4b03bc68199c0e17b",
        "status_raw": "Not screened",
        "screening_date": null
      }
    ],
    "x_unit_id": "unit-456789123",
    "x_lease_id": null,
    "self_reported_income": [
      {
        "amount_in_cents": 325000,
        "amount_raw": "$3,250.00",
        "type_normalized": null,
        "type_raw": null
      }
    ]
  }
}

Get an applicant 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/applicants/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": "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": "ext-987654321",
17	"x_property_id": "prop-123456789",
18	"x_lead_id": null,
19	"x_unit_id_preferred": [
20	"123",
21	"456"
22	],
23	"address_1_alternate": null,
24	"address_1": "123 Main St",
25	"address_2_alternate": null,
26	"address_2": "Apt 4B",
27	"applications": [
28	{
29	"applicant_id": "clwktsp9v000008l31iv218hn",
30	"application_id": "app-20240322-001",
31	"status_raw": "Approved by leasing",
32	"status_normalized": "APPROVED",
33	"custom_data": {},
34	"status": null
35	}
36	],
37	"city_alternate": null,
38	"city": "Boston",
39	"country_alternate": null,
40	"country": "US",
41	"custom_data": {},
42	"date_of_birth": "1990-07-15",
43	"email_1": "sally.jones@example.com",
44	"email_2": null,
45	"first_name": "Sally",
46	"last_name": "Jones",
47	"middle_name": null,
48	"notes": null,
49	"phone_1_type": "MOBILE",
50	"phone_1": "(617) 555-1234",
51	"phone_2_type": "FAX",
52	"phone_2": "(617) 555-5678",
53	"state_alternate": null,
54	"state": "MA",
55	"type_normalized": null,
56	"type_raw": null,
57	"zip_alternate": null,
58	"zip": "02116",
59	"pets": [
60	{
61	"id": "pet-001",
62	"created_at": "2024-03-21T15:38:08.337Z",
63	"updated_at": "2024-03-22T10:59:45.119Z",
64	"last_seen": "2024-03-22T10:59:45.119Z",
65	"x_id": "ext-pet-123",
66	"age_in_years": 3,
67	"breed": "Golden Retriever",
68	"color": "Golden",
69	"gender_raw": "Female",
70	"is_declawed": false,
71	"is_fixed": true,
72	"is_service_animal": false,
73	"is_trained": true,
74	"is_vaccinated": true,
75	"name": "Buddy",
76	"notes": "Very friendly and well-behaved",
77	"type": "Dog",
78	"weight_in_pounds": 65,
79	"custom_data": {}
80	}
81	],
82	"integration_id": "clwh5u07w000508me66sfh3um",
83	"integration_vendor": "REALPAGE_RPX",
84	"property_id": "clwi5xiix000008l6ctdgafyh",
85	"unit_id_preferred": [
86	"testintegration:123:123",
87	"testintegration:456:456"
88	],
89	"screenings": [
90	{
91	"id": "screen-001",
92	"created_at": "2024-03-21T15:38:08.337Z",
93	"last_seen": "2024-03-22T10:59:45.119Z",
94	"x_id": "c5ca182e295028100d8abbcb1183197eb9455230b5fa78f4b03bc68199c0e17b",
95	"status_raw": "Not screened",
96	"screening_date": null
97	}
98	],
99	"x_unit_id": "unit-456789123",
100	"x_lease_id": null,
101	"self_reported_income": [
102	{
103	"amount_in_cents": 325000,
104	"amount_raw": "$3,250.00",
105	"type_normalized": null,
106	"type_raw": null
107	}
108	]
109	}
110	}