Get a Prospect by ID

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

Authentication

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

Path parameters

prospect_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 prospect
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
Example: 786543
x_community_idstring | nullnullablerequired
The external ID of the community from the integration vendor
Example: 237891
custom_data object | nullrequired
object
first_namestring | nullnullablerequired
The first name associated with the prospect
Example: John
last_namestring | nullnullablerequired
The last name associated with the prospect
Example: Doe
address_rawstring | nullnullablerequired
The raw address associated with the prospect
Example: 123 Sesame St
address_1string | nullnullablerequired
The first address line associated with the prospect
Notice
This field will always be null for KNOCK
Example: 123 Main St
address_2string | nullnullablerequired
The second address line associated with the prospect
Notice
This field will always be null for KNOCK
citystring | nullnullablerequired
The city associated with the prospect
Example: Topeka
statestring | nullnullablerequired
The state associated with the prospect
Example: KS
zipstring | nullnullablerequired
The zip code associated with the prospect
Example: 42756
emailstring | nullnullablerequired
The primary email address associated with the prospect
Example: [email protected]
phone_1string | nullnullablerequired
Primary phone number associated with the prospect
Example: +15555555555
phone_2string | nullnullablerequired
Secondary phone number associated with the prospect
Notice
This field will always be null for KNOCK
move_in_datestring | nullnullablerequired
The move-in date associated with the prospect
Example: 2025-01-01T00:00:00.000Z
minimum_budget_in_centsnumber | nullnullablerequired
The minimum budget, in cents, of the prospect
Example: 130000
maximum_budget_in_centsnumber | nullnullablerequired
The maximum budget, in cents, of the prospect
Example: 230000
community_idstring | nullnullablerequired
The Propexo unique identifier for the community
Example: testintegration:crm:237891
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum31required
The CRM system of record
Show 5 enum values
KNOCKELISEAIFUNNELRENTCAFEKNOCK
Example: KNOCK

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/:prospect_id

curl https://api.propexo.com/crm/v1/prospects/:prospect_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_id": "786543",
    "x_community_id": "237891",
    "custom_data": "Unknown Type: object,null",
    "first_name": "John",
    "last_name": "Doe",
    "address_raw": "123 Sesame St",
    "address_1": "123 Main St",
    "address_2": "string",
    "city": "Topeka",
    "state": "KS",
    "zip": "42756",
    "email": "[email protected]",
    "phone_1": "+15555555555",
    "phone_2": "string",
    "move_in_date": "2025-01-01T00:00:00.000Z",
    "minimum_budget_in_cents": 130000,
    "maximum_budget_in_cents": 230000,
    "community_id": "testintegration:crm:237891",
    "integration_id": "clwh5u07w000508me66sfh3um",
    "integration_vendor": "KNOCK"
  }
}