Get all Prospects

GEThttps://api.propexo.com/crm/v1/prospects/

Authentication

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

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

integration_id string

The Propexo unique identifier for the integration

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The CRM system of record

community_id string

The Propexo unique identifier for the community

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
Array [
object
]
hasMoreboolean | nullnullable
Whether there are more results
totalinteger
The total number of results
Possible values: >= 0
Example: 1000
results object[]required
Array [
idstringrequired
The Propexo unique identifier for the prospect
created_atstringrequired
The date record first entered Propexo
updated_atstringrequired
The date record was last updated in Propexo
last_seenstring | nullnullablerequired
The date the record was last seen from the PMS
x_idstringrequired
The external ID from the integration vendor
x_community_idstring | nullnullablerequired
The external ID of the community from the integration vendor
custom_data object | nullrequired
object
first_namestring | nullnullablerequired
The first name associated with the prospect
last_namestring | nullnullablerequired
The last name associated with the prospect
address_rawstring | nullnullablerequired
The raw address associated with the prospect
address_1string | nullnullablerequired
The first address line associated with the prospect
address_2string | nullnullablerequired
The second address line associated with the prospect
citystring | nullnullablerequired
The city associated with the prospect
statestring | nullnullablerequired
The state associated with the prospect
zipstring | nullnullablerequired
The zip code associated with the prospect
emailstring | nullnullablerequired
The primary email address associated with the prospect
phone_1string | nullnullablerequired
Primary phone number associated with the prospect
phone_2string | nullnullablerequired
Secondary phone number associated with the prospect
move_in_datestring | nullnullablerequired
The move-in date associated with the prospect
minimum_budget_in_centsnumber | nullnullablerequired
The minimum budget, in cents, of the prospect
Example: 100000
maximum_budget_in_centsnumber | nullnullablerequired
The maximum budget, in cents, of the prospect
Example: 100000
community_idstring | nullnullablerequired
The Propexo unique identifier for the community
integration_idstringrequired
The Propexo unique identifier for the integration
integration_vendorEnum12required
The CRM system of record
Show 13 enum values
APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
]

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 /crm/v1/prospects/

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

200 Successful response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "orderBy": [
      {}
    ],
    "hasMore": true,
    "total": 1000
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "last_seen": "string",
      "x_id": "string",
      "x_community_id": "string",
      "custom_data": "Unknown Type: object,null",
      "first_name": "string",
      "last_name": "string",
      "address_raw": "string",
      "address_1": "string",
      "address_2": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "email": "string",
      "phone_1": "string",
      "phone_2": "string",
      "move_in_date": "string",
      "minimum_budget_in_cents": 100000,
      "maximum_budget_in_cents": 100000,
      "community_id": "string",
      "integration_id": "string",
      "integration_vendor": "APPFOLIO"
    }
  ]
}