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 applicants
        • POSTCreate applicant
        • GETGet an applicant by ID
        • PUTUpdate applicant
        • GETGet rentable items for an applicant
        • POSTAssign a rentable item for an applicant
    • CRM Generic APIs
    • PMS APIs
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
PMS Generic APIsApplicants

Get all applicants

GET
/v1/applicants/
GET
/v1/applicants/
$curl https://api.propexo.com/v1/applicants/ \
>     -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    {
13      "id": "a3f1c9e2-4b7d-4f9a-9c3e-2d5f7b8a1c2d",
14      "created_at": "2024-05-10T09:15:00Z",
15      "updated_at": "2024-06-01T12:00:00Z",
16      "last_seen": "2024-06-01T11:45:00Z",
17      "x_id": "EXT123456789",
18      "x_property_id": "PROP987654321",
19      "x_lead_id": "LEAD67890",
20      "x_unit_id_preferred": [
21        "UNIT12345",
22        "UNIT12346"
23      ],
24      "address_1_alternate": "123 Elm St Apt 4B",
25      "address_1": "456 Oak St",
26      "address_2_alternate": "Building 5",
27      "address_2": "Suite 200",
28      "applications": [
29        {
30          "applicant_id": "a3f1c9e2-4b7d-4f9a-9c3e-2d5f7b8a1c2d",
31          "application_id": "app-7890",
32          "status_raw": "Approved by landlord",
33          "status_normalized": "APPROVED",
34          "custom_data": {},
35          "status": null
36        }
37      ],
38      "city_alternate": "Springfield",
39      "city": "Shelbyville",
40      "country_alternate": "USA",
41      "country": "USA",
42      "custom_data": {},
43      "date_of_birth": "1990-04-15",
44      "email_1": "jane.doe@example.com",
45      "email_2": "j.doe@workmail.com",
46      "first_name": "Jane",
47      "last_name": "Doe",
48      "middle_name": "A",
49      "notes": "Prefers a quiet neighborhood.",
50      "phone_1_type": "MOBILE",
51      "phone_1": "5551234567",
52      "phone_2_type": "WORK",
53      "phone_2": "5557654321",
54      "state_alternate": "IL",
55      "state": "IL",
56      "type_normalized": "INDIVIDUAL",
57      "type_raw": "Primary applicant",
58      "zip_alternate": "62704",
59      "zip": "62701",
60      "pets": [
61        {
62          "id": "pet-001",
63          "created_at": "2024-05-10T09:20:00Z",
64          "updated_at": "2024-06-01T11:50:00Z",
65          "last_seen": "2024-06-01T11:45:00Z",
66          "x_id": "PETEXT123",
67          "age_in_years": 3,
68          "breed": "Golden Retriever",
69          "color": "Golden",
70          "gender_raw": "Female",
71          "is_declawed": false,
72          "is_fixed": true,
73          "is_service_animal": false,
74          "is_trained": true,
75          "is_vaccinated": true,
76          "name": "Bella",
77          "notes": "Very friendly and well-behaved.",
78          "type": "Dog",
79          "weight_in_pounds": 65,
80          "custom_data": {}
81        }
82      ],
83      "integration_id": "int-4567",
84      "integration_vendor": "APPFOLIO",
85      "property_id": "prop-1234",
86      "unit_id_preferred": [
87        "unit-101",
88        "unit-102"
89      ],
90      "screenings": [
91        {
92          "id": "screen-789",
93          "created_at": "2024-05-15T10:00:00Z",
94          "last_seen": "2024-06-01T11:40:00Z",
95          "x_id": "SCR123456",
96          "status_raw": "Clear",
97          "screening_date": "2024-05-14"
98        }
99      ],
100      "x_unit_id": "UNIT12345",
101      "x_lease_id": "LEASE54321",
102      "self_reported_income": [
103        {
104          "amount_in_cents": 5500000,
105          "amount_raw": "$55,000",
106          "type_normalized": "EMPLOYMENT",
107          "type_raw": "Full-time job"
108        }
109      ]
110    }
111  ]
112}
Get all applicants
Was this page helpful?
Previous

Create applicant

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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
x_idstringOptional
The external ID from the integration vendor
location_idstringOptional

The Propexo unique identifier for the location associated with the property (exclusive to Rent Manager integrations). This is always null for non-Rent Manager integrations.

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
email_1stringOptional
The primary email address associated with the applicant
phone_1stringOptionalformat: "^[2-9]\d{9}$"

Filter by phone number (10 digit format only)

Response

Successful response
metaobject
resultslist of objects

Errors

400
Bad Request Error