Get a lead by ID

GEThttps://api.propexo.com/v1/leads/:id

Authentication

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

Path parameters

id stringrequired

The ID of the resource.

Query parameters

order-by string

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

Default value: created_at:desc

updated_at_gte string | null

Filter to records updated at or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

updated_at_lte string | null

Filter to records updated at or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

last_seen_gte string | null

Filter to records whose last_seen date is on or after this datetime. Format: ISO 8601 (e.g. 2026-01-01T00:00:00Z)

last_seen_lte string | null

Filter to records whose last_seen date is on or before this datetime. Format: ISO 8601 (e.g. 2026-12-31T23:59:59Z)

offset integer | null

Possible values: >= 0

Can be used for paginating results

Default value: 0

limit integer | null

Possible values: >= 0 and <= 250

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

Default value: 100

Response

Successful response

meta objectrequired
offsetinteger
The offset of the first result
Possible values: >= 0
Example: 0
limitinteger
The number of results to return
Possible values: >= 0 and <= 250
Example: 100
orderBy object[]required
The order of the results
Array [
object
]
hasMoreboolean | nullnullable
Whether there are more results
totalinteger
The total number of results
Possible values: >= 0
Example: 1000
results objectrequired
idstringrequired
The Propexo unique identifier for the lead
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_created_atstring | nullnullablerequired
The date the record first entered the integration vendor
Method
GET /Contacts
Example: 2022-02-28T17:05:43.000Z
x_guestcard_idnullrequired
The external ID of the guestcard from the integration vendor
Notice
This field will always be null for RENTMANAGER
Example: null
x_idstringrequired
The external ID from the integration vendor
Method
GET /Contacts
GET /Prospects/{prospectId}
Example: 43
x_leasing_agent_idnullrequired
The external ID of the leasing agent from the integration vendor
Notice
This field will always be null for RENTMANAGER
Example: null
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
GET /Contacts
GET /Prospects/{prospectId}
Example: 1
x_unit_idnullrequireddeprecated
DEPRECATED: Use x_unit_id_preferred instead
Notice
This field will always be null for RENTMANAGER
Example: null
x_unit_id_preferredstring[]required
The external IDs of the units from the integration vendor that the lead is interested in
Method
GET /Contacts
Example: ["123"]
x_updated_atnullrequired
The date the record was last updated in the integration vendor
Notice
This field will always be null for RENTMANAGER
Example: null
x_lead_source_idstring | nullnullablerequired
The external ID of the lead source from the integration vendor
Method
GET /Contacts
Example: 1
address_1string | nullnullablerequired
The first address line associated with the lead
Method
GET /Contacts
Example: 200 Pine Street
address_2nullrequired
The second address line associated with the lead
Notice
This field will always be null for RENTMANAGER
Example: null
citystring | nullnullablerequired
The city associated with the lead
Method
GET /Contacts
Example: Denver
countrynullrequired
The country associated with the lead
Notice
This field will always be null for RENTMANAGER
Example: null
custom_data object | nullrequired
object
date_of_birthstring | nullnullablerequired
The date of birth associated with the lead
Method
GET /Contacts
Example: 1992-03-14T00:00:00.000Z
desired_amenitiesnullrequired
The desired amenities associated with the lead
Notice
This field will always be null for RENTMANAGER
Example: null
desired_floor_plan_idnullrequired
The external ID of desired floor plan associated with the lead
Notice
This field will always be null for RENTMANAGER
Example: null
desired_floor_plan_namenullrequired
The desired floor plan name
Notice
This field will always be null for RENTMANAGER
Example: null
desired_lease_term_in_monthsnullrequired
The desired lease term
Notice
This field will always be null for RENTMANAGER
Example: null
desired_max_rent_in_centsnumber | nullnullablerequired
The desired maximum rent
Important
Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.
Method
GET /Prospects/{prospectId}
Example: 2600
desired_max_square_ftnullrequired
The desired maximum square feet
Notice
This field will always be null for RENTMANAGER
Example: null
desired_min_rent_in_centsnumber | nullnullablerequired
The desired minimum rent
Important
Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.
Method
GET /Prospects/{prospectId}
Example: 1200
desired_min_square_ftnullrequired
The desired minimum square feet
Notice
This field will always be null for RENTMANAGER
Example: null
desired_num_bathroomsnumber | nullnullablerequired
The desired number of bathrooms
Important
Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.
Method
GET /Prospects/{prospectId}
Example: 2
desired_num_bedroomsinteger | nullnullablerequired
The desired number of bedrooms
Important
Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.
Method
GET /Prospects/{prospectId}
Example: 2
desired_unit_numbernullrequired
The desired unit number
Notice
This field will always be null for RENTMANAGER
Example: null
desired_unit_typenullrequired
The desired unit type
Notice
This field will always be null for RENTMANAGER
Example: null
email_1string | nullnullablerequired
The primary email address associated with the lead
Method
GET /Contacts
Example: [email protected]
email_2nullrequired
The secondary email address associated with the lead
Notice
This field will always be null for RENTMANAGER
Example: null
first_namestring | nullnullablerequired
The first name associated with the lead
Method
GET /Contacts
Example: Jordan
ilsnullrequired
The name of the Internet listing service
Notice
This field will always be null for RENTMANAGER
Example: null
last_namestring | nullnullablerequired
The last name associated with the lead
Method
GET /Contacts
Example: Lee
lead_sourcenullrequired
The lead source
Notice
This field will always be null for RENTMANAGER
Example: null
leasing_agentnullrequired
The name of the leasing agent
Notice
This field will always be null for RENTMANAGER
Example: null
middle_namestring | nullnullablerequired
The middle name associated with the lead
Method
GET /Contacts
Example: A
notesstring | nullnullablerequired
Notes associated with the lead
Method
GET /Contacts
Example: Prefers afternoon showings
number_of_occupantsnullrequired
The number of occupants
Notice
This field will always be null for RENTMANAGER
Example: null
pet_detailsnullrequireddeprecated
DEPRECATED: Use the pets array instead
Notice
This field will always be null for RENTMANAGER
Example: null
pets object[]required
The pets associated with the lead
Notice
This field is not currently hydrated for RENTMANAGER
Array [
idstringrequired
The Propexo unique identifier for the lead pet
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
updated_atstringrequired
The date record was last updated in Propexo
Example: 2024-03-22T10:59:45.119Z
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_idstringrequired
The external ID from the integration vendor
age_in_yearsnumber | nullnullablerequired
The age in years of the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
breedstring | nullnullablerequired
The breed of the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
colorstring | nullnullablerequired
The color of the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
gender_rawstring | nullnullablerequired
The raw value for the gender of the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
is_fixedboolean | nullnullablerequired
Whether the lead pet is fixed
Notice
This field is not currently hydrated for RENTMANAGER
is_service_animalboolean | nullnullablerequired
Whether the lead pet is a service animal
Notice
This field is not currently hydrated for RENTMANAGER
namestring | nullnullablerequired
The name associated with the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
notesstring | nullnullablerequired
Notes associated with the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
typestring | nullnullablerequired
The type associated with the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
weight_in_poundsnumber | nullnullablerequired
The weight in pounds of the lead pet
Notice
This field is not currently hydrated for RENTMANAGER
custom_data object | nullrequired
object
]
phone_1_typestring | nullnullablerequired
Type of the primary phone number
Method
GET /Contacts
Example: MOBILE
phone_1string | nullnullablerequired
Primary phone number associated with the lead
Method
GET /Contacts
Example: (555) 555-0142
phone_2_typestring | nullnullablerequired
Type of the secondary phone number
Method
GET /Contacts
Example: HOME
phone_2string | nullnullablerequired
Secondary phone number associated with the lead
Method
GET /Contacts
Example: (555) 555-0143
statestring | nullnullablerequired
The state associated with the lead
Method
GET /Contacts
Example: CO
statusstring | nullnullablerequired
The raw status associated with the lead
Method
GET /Contacts
Example: Prospect
target_move_in_datestring | nullnullablerequired
The target move in date
Important
Hydrating this field requires making requests to an additional API which will increase your processed records count. Please contact support to enable.
Method
GET /Prospects/{prospectId}
Example: 2025-01-01T00:00:00.000Z
zipstring | nullnullablerequired
The zip code associated with the lead
Method
GET /Contacts
Example: 80202
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
lead_source_idstring | nullnullablerequired
The Propexo unique identifier for the lead source
Method
GET /Contacts
Example: testintegration:na:1:1
unit_id_preferredstring[]required
The Propexo unique identifiers for the units that the lead is interested in
Method
GET /Contacts
Example: ["testintegration:na:1:123"]
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum21required
The property management system of record
Show 13 enum values
RENTMANAGERAPPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTVINERESMANYARDIYARDI_REST
Example: RENTMANAGER
screenings object[]required
Notice
This field is not currently hydrated for RENTMANAGER
Array [
idstringrequired
The Propexo ID of the screening
Example: clwktsp9v000008l31iv218hn
created_atstringrequired
The date record first entered Propexo
Example: 2024-03-21T15:38:08.337Z
last_seenstringrequired
The date the record was last seen from the PMS
Example: 2024-03-22T10:59:45.119Z
x_idstringrequired
The external ID from the integration vendor
status_rawstring | nullnullablerequired
The status/results of the screening
Notice
This field is not currently hydrated for RENTMANAGER
screening_datestring | nullnullablerequired
The date the screening took place
Notice
This field is not currently hydrated for RENTMANAGER
]

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

GET /v1/leads/:id

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

200 Successful response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "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_created_at": "2022-02-28T17:05:43.000Z",
    "x_guestcard_id": null,
    "x_id": "43",
    "x_leasing_agent_id": null,
    "x_property_id": "1",
    "x_unit_id_preferred": [
      "123"
    ],
    "x_updated_at": null,
    "x_lead_source_id": "1",
    "address_1": "200 Pine Street",
    "address_2": null,
    "city": "Denver",
    "country": null,
    "custom_data": "Unknown Type: object,null",
    "date_of_birth": "1992-03-14T00:00:00.000Z",
    "desired_amenities": null,
    "desired_floor_plan_id": null,
    "desired_floor_plan_name": null,
    "desired_lease_term_in_months": null,
    "desired_max_rent_in_cents": 2600,
    "desired_max_square_ft": null,
    "desired_min_rent_in_cents": 1200,
    "desired_min_square_ft": null,
    "desired_num_bathrooms": 2,
    "desired_num_bedrooms": 2,
    "desired_unit_number": null,
    "desired_unit_type": null,
    "email_1": "[email protected]",
    "email_2": null,
    "first_name": "Jordan",
    "ils": null,
    "last_name": "Lee",
    "lead_source": null,
    "leasing_agent": null,
    "middle_name": "A",
    "notes": "Prefers afternoon showings",
    "number_of_occupants": null,
    "pets": [
      {
        "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": "string",
        "age_in_years": 0,
        "breed": "string",
        "color": "string",
        "gender_raw": "string",
        "is_fixed": true,
        "is_service_animal": true,
        "name": "string",
        "notes": "string",
        "type": "string",
        "weight_in_pounds": 0,
        "custom_data": "Unknown Type: object,null"
      }
    ],
    "phone_1_type": "MOBILE",
    "phone_1": "(555) 555-0142",
    "phone_2_type": "HOME",
    "phone_2": "(555) 555-0143",
    "state": "CO",
    "status": "Prospect",
    "target_move_in_date": "2025-01-01T00:00:00.000Z",
    "zip": "80202",
    "property_id": "clwi5xiix000008l6ctdgafyh",
    "lead_source_id": "testintegration:na:1:1",
    "unit_id_preferred": [
      "testintegration:na:1:123"
    ],
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "RENTMANAGER",
    "screenings": [
      {
        "id": "clwktsp9v000008l31iv218hn",
        "created_at": "2024-03-21T15:38:08.337Z",
        "last_seen": "2024-03-22T10:59:45.119Z",
        "x_id": "string",
        "status_raw": "string",
        "screening_date": "string"
      }
    ]
  }
}