Get all applicants

GEThttps://api.propexo.com/v1/applicants/

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

x_id string

The external ID from the integration vendor

location_id string

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_id string

The Propexo unique identifier for the property

integration_id string

The Propexo unique identifier for the integration

integration_vendor string

Show 13 enum values

APPFOLIOBUILDIUMENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST

The property management system of record

email_1 string

The primary email address associated with the applicant

phone_1 string

Possible values: Value must match regular expression ^[2-9]\d{9}$

Filter by phone number (10 digit format only)

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 object[]required
Array [
idstringrequired
The Propexo unique identifier for the applicant
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
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 000000123
x_property_idstringrequired
The external ID of the property from the integration vendor
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 123
x_unit_idnullrequireddeprecated
DEPRECATED: Use x_unit_id_preferred instead
Notice
This field will always be null for MRI
Example: null
x_lease_idnullrequireddeprecated
DEPRECATED: Not in use.
Notice
This field will always be null for MRI
Example: null
x_lead_idstring | nullnullablerequired
The external ID of the lead from the integration vendor
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 000000123
x_unit_id_preferredstring[]required
The external IDs of the units from the integration vendor that the applicant is interested in
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: ["04"]
address_1_alternatestring | nullnullablerequired
The first alternate address line associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 123 Back Street
address_1string | nullnullablerequired
The first address line associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 123 Round Street
address_2_alternatestring | nullnullablerequired
The second alternate address line associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Apt 11
address_2string | nullnullablerequired
The second address line associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Suite 827
applications object[]required
Applications that the applicant has submitted
Notice
This field is not currently hydrated for MRI
Array [
applicant_idstringrequired
Notice
This field is not currently hydrated for MRI
application_idstringrequired
Notice
This field is not currently hydrated for MRI
statusstring | nullnullabledeprecated
DEPRECATED. Use status_raw or status_normalized
status_rawstring | nullnullable
The raw status associated with the applicant
Notice
This field is not currently hydrated for MRI
status_normalizedstring | nullnullable
The normalized status associated with the applicant. Confirm these derived values before using them in production.
Notice
This field is not currently hydrated for MRI
Show 2 variants
• stringAPPROVEDDENIEDCANCELEDOTHERPENDING
• string
custom_data object | null
object
]
city_alternatestring | nullnullablerequired
The alternate city associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Newark
citystring | nullnullablerequired
The city associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Newark
country_alternatenullrequired
The alternate country associated with the applicant
Notice
This field will always be null for MRI
Example: null
countrynullrequired
The country associated with the applicant
Notice
This field will always be null for MRI
Example: null
custom_data object | nullrequired
object
date_of_birthstring | nullnullablerequired
The date of birth associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 2000-01-05T00:00:00.000Z
email_1string | nullnullablerequired
The primary email address associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: [email protected]
email_2nullrequired
The secondary email address associated with the applicant
Notice
This field will always be null for MRI
Example: null
first_namestring | nullnullablerequired
The first name associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Jane
self_reported_income object[]
Self reported income sources for the applicant
Notice
This field is not currently hydrated for MRI
Array [
amount_in_centsnumber | nullnullablerequired
The total income of the applicant, in cents
Notice
This field is not currently hydrated for MRI
Example: 325000
amount_rawstring | nullnullablerequired
The total income amount of the applicant
Notice
This field is not currently hydrated for MRI
type_normalizednullrequired
The type of income of the applicant
Notice
This field will always be null for MRI
Example: null
type_rawnullrequired
The type of income of the applicant
Notice
This field will always be null for MRI
Example: null
]
last_namestring | nullnullablerequired
The last name associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Doe
middle_namestring | nullnullablerequired
The middle name associated with the applicant
Important
MRI only gives the middle initial.
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: J
notesstring | nullnullablerequired
Notes associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: Visit-N
phone_1_typestring | nullnullablerequired
Type of the primary phone number
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: MOBILE
phone_1string | nullnullablerequired
Primary phone number associated with the applicant
Important
MRI offers mobile, home, work, and fax numbers. Propexo stores these in that priority order. If you need more fields for the other numbers, contact Propexo support.
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 5555555555
phone_2_typestring | nullnullablerequired
Type of the secondary phone number
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
Example: HOME
phone_2string | nullnullablerequired
Secondary phone number associated with the applicant
Important
MRI offers mobile, home, work, and fax numbers. Propexo stores these in that priority order. If you need more fields for the other numbers, contact Propexo support.
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 5555555554
state_alternatestring | nullnullablerequired
The alternate state associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: NJ
statestring | nullnullablerequired
The state associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: NJ
type_normalizednullrequired
The normalized type associated with the applicant
Notice
This field will always be null for MRI
Example: null
type_rawnullrequired
The raw type associated with the applicant
Notice
This field will always be null for MRI
Example: null
zip_alternatestring | nullnullablerequired
The alternate zip code associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 12378
zipstring | nullnullablerequired
The zip code associated with the applicant
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 17892
pets object[]required
Array [
idstringrequired
The Propexo unique identifier for the applicant 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
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: 89
age_in_yearsnullrequired
The age in years of the applicant pet
Notice
This field will always be null for MRI
Example: null
breednullrequired
The breed of the applicant pet
Notice
This field will always be null for MRI
Example: null
colornullrequired
The color of the applicant pet
Notice
This field will always be null for MRI
Example: null
gender_rawnullrequired
The raw value for the gender of the applicant pet
Notice
This field will always be null for MRI
Example: null
is_declawednullrequired
Whether the applicant pet is declawed
Notice
This field will always be null for MRI
Example: null
is_fixednullrequired
Whether the applicant pet is fixed
Notice
This field will always be null for MRI
Example: null
is_service_animalnullrequired
Whether the applicant pet is a service animal
Notice
This field will always be null for MRI
Example: null
is_trainednullrequired
Whether the applicant pet is trained
Notice
This field will always be null for MRI
Example: null
is_vaccinatednullrequired
Whether the applicant pet is vaccinated
Notice
This field will always be null for MRI
Example: null
namenullrequired
The name associated with the applicant pet
Notice
This field will always be null for MRI
Example: null
notesnullrequired
Notes associated with the applicant pet
Notice
This field will always be null for MRI
Example: null
typestring | nullnullablerequired
The type associated with the applicant pet
Method
/mriapiservices/api.asp?$api=MRI_S-PMRM_ProspectsApplicantsAndResidents
Example: D
weight_in_poundsnullrequired
The weight in pounds of the applicant pet
Notice
This field will always be null for MRI
Example: null
custom_data object | nullrequired
object
]
integration_idstringrequired
The Propexo unique identifier for the integration
Example: clwh5u07w000508me66sfh3um
integration_vendorEnum16required
The property management system of record
Show 13 enum values
MRIAPPFOLIOBUILDIUMENTRATAPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
Example: MRI
property_idstringrequired
The Propexo unique identifier for the property
Example: clwi5xiix000008l6ctdgafyh
unit_id_preferrednullrequired
The Propexo unique identifiers for the units that the applicant is interested in
Notice
This field will always be null for MRI
Example: null
screenings object[]required
Notice
This field is not currently hydrated for MRI
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 MRI
screening_datestring | nullnullablerequired
The date the screening took place
Notice
This field is not currently hydrated for MRI
]
]

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/applicants/

curl https://api.propexo.com/v1/applicants/ \
     -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": "000000123",
      "x_property_id": "123",
      "x_lead_id": "000000123",
      "x_unit_id_preferred": [
        "04"
      ],
      "address_1_alternate": "123 Back Street",
      "address_1": "123 Round Street",
      "address_2_alternate": "Apt 11",
      "address_2": "Suite 827",
      "applications": [
        {
          "applicant_id": "string",
          "application_id": "string",
          "status_raw": "string",
          "status_normalized": "APPROVED",
          "custom_data": "Unknown Type: object,null"
        }
      ],
      "city_alternate": "Newark",
      "city": "Newark",
      "country_alternate": null,
      "country": null,
      "custom_data": "Unknown Type: object,null",
      "date_of_birth": "2000-01-05T00:00:00.000Z",
      "email_1": "[email protected]",
      "email_2": null,
      "first_name": "Jane",
      "self_reported_income": [
        {
          "amount_in_cents": 325000,
          "amount_raw": "string",
          "type_normalized": null,
          "type_raw": null
        }
      ],
      "last_name": "Doe",
      "middle_name": "J",
      "notes": "Visit-N",
      "phone_1_type": "MOBILE",
      "phone_1": "5555555555",
      "phone_2_type": "HOME",
      "phone_2": "5555555554",
      "state_alternate": "NJ",
      "state": "NJ",
      "type_normalized": null,
      "type_raw": null,
      "zip_alternate": "12378",
      "zip": "17892",
      "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": "89",
          "age_in_years": null,
          "breed": null,
          "color": null,
          "gender_raw": null,
          "is_declawed": null,
          "is_fixed": null,
          "is_service_animal": null,
          "is_trained": null,
          "is_vaccinated": null,
          "name": null,
          "notes": null,
          "type": "D",
          "weight_in_pounds": null,
          "custom_data": "Unknown Type: object,null"
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "MRI",
      "property_id": "clwi5xiix000008l6ctdgafyh",
      "unit_id_preferred": null,
      "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"
        }
      ]
    }
  ]
}