Applicants

Get an applicant by ID

GET

Path parameters

idstringRequired

Query parameters

order-bystringOptional

offsetintegerOptional

limitintegerOptional

Response

This endpoint returns an object

meta

object

results

object

GET

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

200Retrieved

1 {
2   "meta": {
3     "orderBy": [
4       {}
5     ],
6     "offset": 1,
7     "limit": 1,
8     "hasMore": true,
9     "total": 1
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     "x_id": "sample_value",
16     "x_property_id": "sample_value",
17     "applications": [
18       {
19         "applicant_id": "applicant_id",
20         "application_id": "application_id"
21       }
22     ],
23     "integration_id": "clwh5u07w000508me66sfh3um",
24     "integration_vendor": "BUILDIUM",
25     "property_id": "clwi5xiix000008l6ctdgafyh",
26     "screenings": [
27       {
28         "id": "id",
29         "created_at": "created_at",
30         "last_seen": "last_seen",
31         "x_id": "x_id"
32       }
33     ],
34     "last_seen": "2024-03-22T10:59:45.119Z",
35     "x_unit_id": "sample_value",
36     "x_lease_id": "null",
37     "x_lead_id": "null",
38     "address_1_alternate": "null",
39     "address_1": "null",
40     "address_2_alternate": "null",
41     "address_2": "null",
42     "city_alternate": "null",
43     "city": "null",
44     "country_alternate": "null",
45     "country": "null",
46     "date_of_birth": "null",
47     "email_1": "example_email_1@email.com",
48     "email_2": "email_2",
49     "first_name": "Sally",
50     "last_name": "Jones",
51     "middle_name": "null",
52     "notes": "null",
53     "phone_1_type": "MOBILE",
54     "phone_1": "(123) 555-1234",
55     "phone_2_type": "FAX",
56     "phone_2": "sample_value",
57     "state_alternate": "null",
58     "state": "null",
59     "zip_alternate": "null",
60     "zip": "null"
61   }
62 }

Built with

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

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 1,
7	"limit": 1,
8	"hasMore": true,
9	"total": 1
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	"x_id": "sample_value",
16	"x_property_id": "sample_value",
17	"applications": [
18	{
19	"applicant_id": "applicant_id",
20	"application_id": "application_id"
21	}
22	],
23	"integration_id": "clwh5u07w000508me66sfh3um",
24	"integration_vendor": "BUILDIUM",
25	"property_id": "clwi5xiix000008l6ctdgafyh",
26	"screenings": [
27	{
28	"id": "id",
29	"created_at": "created_at",
30	"last_seen": "last_seen",
31	"x_id": "x_id"
32	}
33	],
34	"last_seen": "2024-03-22T10:59:45.119Z",
35	"x_unit_id": "sample_value",
36	"x_lease_id": "null",
37	"x_lead_id": "null",
38	"address_1_alternate": "null",
39	"address_1": "null",
40	"address_2_alternate": "null",
41	"address_2": "null",
42	"city_alternate": "null",
43	"city": "null",
44	"country_alternate": "null",
45	"country": "null",
46	"date_of_birth": "null",
47	"email_1": "example_email_1@email.com",
48	"email_2": "email_2",
49	"first_name": "Sally",
50	"last_name": "Jones",
51	"middle_name": "null",
52	"notes": "null",
53	"phone_1_type": "MOBILE",
54	"phone_1": "(123) 555-1234",
55	"phone_2_type": "FAX",
56	"phone_2": "sample_value",
57	"state_alternate": "null",
58	"state": "null",
59	"zip_alternate": "null",
60	"zip": "null"
61	}
62	}