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 leads
        • POSTCreate lead
        • GETGet a lead by ID
        • PUTUpdate lead
        • GETGet all lead relationships
        • GETGet all lead sources
        • GETGet lead source by ID
        • GETGet rentable items for a lead
    • CRM Generic APIs
    • PMS APIs
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
PMS Generic APIsLeads

Get all leads

GET
/v1/leads/
GET
/v1/leads/
$curl https://api.propexo.com/v1/leads/ \
>     -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": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
14      "created_at": "2024-05-01T09:15:00Z",
15      "updated_at": "2024-05-10T14:45:00Z",
16      "last_seen": "2024-05-10T14:40:00Z",
17      "x_created_at": "2024-04-30T08:00:00Z",
18      "x_guestcard_id": "GC123456789",
19      "x_id": "EXT987654321",
20      "x_leasing_agent_id": "LA456789123",
21      "x_property_id": "PROP123456",
22      "x_unit_id_preferred": [
23        "UNIT7890"
24      ],
25      "x_updated_at": "2024-05-10T14:30:00Z",
26      "x_lead_source_id": "LS123456",
27      "address_1": "123 Maple Street",
28      "address_2": "Apt 4B",
29      "city": "Springfield",
30      "country": "USA",
31      "custom_data": {},
32      "date_of_birth": "1985-07-20",
33      "desired_amenities": "Pool, Gym, Parking",
34      "desired_floor_plan_id": "FP1234",
35      "desired_floor_plan_name": "2 Bedroom Deluxe",
36      "desired_lease_term_in_months": "12",
37      "desired_max_rent_in_cents": 150000,
38      "desired_max_square_ft": 1200.5,
39      "desired_min_rent_in_cents": 120000,
40      "desired_min_square_ft": 900,
41      "desired_num_bathrooms": 2,
42      "desired_num_bedrooms": 2,
43      "desired_unit_number": "4B",
44      "desired_unit_type": "Apartment",
45      "email_1": "jane.doe@example.com",
46      "email_2": "j.doe.alt@example.com",
47      "first_name": "Jane",
48      "ils": "Zillow",
49      "last_name": "Doe",
50      "lead_source": "Online Ad",
51      "leasing_agent": "Mark Johnson",
52      "middle_name": "A",
53      "notes": "Interested in a quick move-in",
54      "number_of_occupants": 3,
55      "pets": [
56        {
57          "id": "pet123456",
58          "created_at": "2024-04-30T08:05:00Z",
59          "updated_at": "2024-05-01T10:00:00Z",
60          "last_seen": "2024-05-10T14:00:00Z",
61          "x_id": "EXTPET987",
62          "age_in_years": 3.5,
63          "breed": "Beagle",
64          "color": "Brown and White",
65          "gender_raw": "Female",
66          "is_fixed": true,
67          "is_service_animal": false,
68          "name": "Bella",
69          "notes": "Very friendly",
70          "type": "Dog",
71          "weight_in_pounds": 22,
72          "custom_data": {}
73        }
74      ],
75      "phone_1_type": "Mobile",
76      "phone_1": "2125551234",
77      "phone_2_type": "Home",
78      "phone_2": "2125555678",
79      "state": "NY",
80      "status": "New Lead",
81      "target_move_in_date": "2024-06-15",
82      "zip": "10001",
83      "property_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
84      "lead_source_id": "leadsource123",
85      "unit_id_preferred": [
86        "UNIT7890"
87      ],
88      "integration_id": "intg123456",
89      "integration_vendor": "APPFOLIO",
90      "screenings": [
91        {
92          "id": "scrn123456",
93          "created_at": "2024-05-02T11:00:00Z",
94          "last_seen": "2024-05-10T14:00:00Z",
95          "x_id": "EXTSCRN789",
96          "status_raw": "Passed",
97          "screening_date": "2024-05-05"
98        }
99      ],
100      "x_unit_id": "UNIT7890",
101      "pet_details": "Two small dogs"
102    }
103  ]
104}
Get all leads
Was this page helpful?
Previous

Create lead

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 lead id
x_property_idstringOptional

Deprecated: Use the Propexo property_id instead

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.

x_unit_idstringOptional
The external unit id
email_1stringOptional
Lead email address
email_2stringOptional
Lead email address alternate
property_idstringOptional
The Propexo property id
integration_idstringOptional
The Propexo integration id
integration_vendorenumOptional
The integration vendor for the lead.
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