Get all applicants

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

x_idstringOptional

The external ID from the integration vendor

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

1 curl https://api.propexo.com/v1/applicants/ \ 2 -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 { 13 "id": "id", 14 "created_at": "created_at", 15 "updated_at": "updated_at", 16 "x_id": "x_id", 17 "x_property_id": "x_property_id", 18 "x_unit_id_preferred": [ 19 "x_unit_id_preferred" 20 ], 21 "applications": [ 22 { 23 "applicant_id": "applicant_id", 24 "application_id": "application_id" 25 } 26 ], 27 "pets": [ 28 { 29 "id": "id", 30 "created_at": "created_at", 31 "updated_at": "updated_at", 32 "x_id": "x_id", 33 "type": "type" 34 } 35 ], 36 "integration_id": "integration_id", 37 "integration_vendor": "SAMPLE2", 38 "property_id": "property_id", 39 "unit_id_preferred": [ 40 "unit_id_preferred" 41 ], 42 "screenings": [ 43 { 44 "id": "id", 45 "created_at": "created_at", 46 "last_seen": "last_seen", 47 "x_id": "x_id" 48 } 49 ], 50 "last_seen": "last_seen", 51 "x_lead_id": "x_lead_id", 52 "address_1_alternate": "address_1_alternate", 53 "address_1": "address_1", 54 "address_2_alternate": "address_2_alternate", 55 "address_2": "address_2", 56 "city_alternate": "city_alternate", 57 "city": "city", 58 "country_alternate": "country_alternate", 59 "country": "country", 60 "date_of_birth": "date_of_birth", 61 "email_1": "email_1", 62 "email_2": "email_2", 63 "first_name": "first_name", 64 "last_name": "last_name", 65 "middle_name": "middle_name", 66 "notes": "notes", 67 "phone_1_type": "FAX", 68 "phone_1": "phone_1", 69 "phone_2_type": "FAX", 70 "phone_2": "phone_2", 71 "state_alternate": "state_alternate", 72 "state": "state", 73 "zip_alternate": "zip_alternate", 74 "zip": "zip", 75 "x_unit_id": "x_unit_id", 76 "x_lease_id": "x_lease_id" 77 } 78 ] 79 }

Query parameters

Response

Errors

1	curl https://api.propexo.com/v1/applicants/ \
2	-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	{
13	"id": "id",
14	"created_at": "created_at",
15	"updated_at": "updated_at",
16	"x_id": "x_id",
17	"x_property_id": "x_property_id",
18	"x_unit_id_preferred": [
19	"x_unit_id_preferred"
20	],
21	"applications": [
22	{
23	"applicant_id": "applicant_id",
24	"application_id": "application_id"
25	}
26	],
27	"pets": [
28	{
29	"id": "id",
30	"created_at": "created_at",
31	"updated_at": "updated_at",
32	"x_id": "x_id",
33	"type": "type"
34	}
35	],
36	"integration_id": "integration_id",
37	"integration_vendor": "SAMPLE2",
38	"property_id": "property_id",
39	"unit_id_preferred": [
40	"unit_id_preferred"
41	],
42	"screenings": [
43	{
44	"id": "id",
45	"created_at": "created_at",
46	"last_seen": "last_seen",
47	"x_id": "x_id"
48	}
49	],
50	"last_seen": "last_seen",
51	"x_lead_id": "x_lead_id",
52	"address_1_alternate": "address_1_alternate",
53	"address_1": "address_1",
54	"address_2_alternate": "address_2_alternate",
55	"address_2": "address_2",
56	"city_alternate": "city_alternate",
57	"city": "city",
58	"country_alternate": "country_alternate",
59	"country": "country",
60	"date_of_birth": "date_of_birth",
61	"email_1": "email_1",
62	"email_2": "email_2",
63	"first_name": "first_name",
64	"last_name": "last_name",
65	"middle_name": "middle_name",
66	"notes": "notes",
67	"phone_1_type": "FAX",
68	"phone_1": "phone_1",
69	"phone_2_type": "FAX",
70	"phone_2": "phone_2",
71	"state_alternate": "state_alternate",
72	"state": "state",
73	"zip_alternate": "zip_alternate",
74	"zip": "zip",
75	"x_unit_id": "x_unit_id",
76	"x_lease_id": "x_lease_id"
77	}
78	]
79	}