Skip to main content

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

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: cl9b1nqwe0003jsxq8ab1c2ac
    x_property_idstringrequired

    The external ID of the property from the integration vendor

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: cl9b1nqwe0001jsxq8ab1c2aa
    x_unit_idstring | nullnullablerequireddeprecated

    DEPRECATED: Use x_unit_id_preferred instead

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    x_lease_idnullrequireddeprecated

    DEPRECATED: Not in use.

    Notice

    This field will always be null for BUILDIUM

    Example: null
    x_lead_idnullrequired

    The external ID of the lead from the integration vendor

    Notice

    This field will always be null for BUILDIUM

    Example: null
    x_unit_id_preferrednullrequired

    The external IDs of the units from the integration vendor that the applicant is interested in

    Notice

    This field will always be null for BUILDIUM

    Example: null
    address_1_alternatenullrequired

    The first alternate address line associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    address_1nullrequired

    The first address line associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    address_2_alternatenullrequired

    The second alternate address line associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    address_2nullrequired

    The second address line associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    applications object[]required

    Applications that the applicant has submitted

  • Array [
    • applicant_idstringrequired
    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: clzct7ly60000opoz8kzn17lx
    application_idstringrequired
    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: clzct7ly60000opoz8kzn17lx
    statusnulldeprecated

    DEPRECATED. Use status_raw or status_normalized

    Notice

    This field will always be null for BUILDIUM

    Example: null
    status_rawstring | nullnullable

    The raw status associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: lease pending
    status_normalizedstring | nullnullable

    The normalized status associated with the applicant. Confirm these derived values before using them in production.

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: APPROVED
    Show 2 variants
    • stringAPPROVEDDENIEDCANCELEDOTHERPENDING
    • string
    custom_data object | null
    object
  • ]
    • city_alternatenullrequired

    The alternate city associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    citynullrequired

    The city associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    country_alternatenullrequired

    The alternate country associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    countrynullrequired

    The country associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    custom_data object | nullrequired
    object
    date_of_birthnullrequired

    The date of birth associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    email_1string | nullnullablerequired

    The primary email address associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: [email protected]
    email_2nullrequired

    The secondary email address associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    first_namestring | nullnullablerequired

    The first name associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: Maya
    self_reported_income object[]

    Self reported income sources for the applicant

    Notice

    This field is not currently hydrated for BUILDIUM

  • Array [
    • amount_in_centsnumber | nullnullablerequired

    The total income of the applicant, in cents

    Notice

    This field is not currently hydrated for BUILDIUM

    Example: 325000
    amount_rawstring | nullnullablerequired

    The total income amount of the applicant

    Notice

    This field is not currently hydrated for BUILDIUM

    type_normalizednullrequired

    The type of income of the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    type_rawnullrequired

    The type of income of the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
  • ]
    • last_namestring | nullnullablerequired

    The last name associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: Chen
    middle_namenullrequired

    The middle name associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    notesnullrequired

    Notes associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    phone_1_typestring | nullnullablerequired

    Type of the primary phone number

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Show 5 enum values
    FAXHOMEMOBILEOTHERWORK
    Example: MOBILE
    phone_1string | nullnullablerequired

    Primary phone number associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: (415) 555-0142
    phone_2_typestring | nullnullablerequired

    Type of the secondary phone number

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Show 5 enum values
    FAXHOMEMOBILEOTHERWORK
    Example: HOME
    phone_2string | nullnullablerequired

    Secondary phone number associated with the applicant

    InterfaceMethod
    ApplicantsGET /applicants
    ApplicantsGET /applicants/:applicantId
    Example: (415) 555-0198
    state_alternatenullrequired

    The alternate state associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    statenullrequired

    The state associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    type_normalizednullrequired

    The normalized type associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    type_rawnullrequired

    The raw type associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    zip_alternatenullrequired

    The alternate zip code associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    zipnullrequired

    The zip code associated with the applicant

    Notice

    This field will always be null for BUILDIUM

    Example: null
    pets object[]required
    Notice

    This field is not currently hydrated for BUILDIUM

  • 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

    age_in_yearsnumber | nullnullablerequired

    The age in years of the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    breedstring | nullnullablerequired

    The breed of the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    colorstring | nullnullablerequired

    The color of the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    gender_rawstring | nullnullablerequired

    The raw value for the gender of the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    is_declawedboolean | nullnullablerequired

    Whether the applicant pet is declawed

    Notice

    This field is not currently hydrated for BUILDIUM

    is_fixedboolean | nullnullablerequired

    Whether the applicant pet is fixed

    Notice

    This field is not currently hydrated for BUILDIUM

    is_service_animalboolean | nullnullablerequired

    Whether the applicant pet is a service animal

    Notice

    This field is not currently hydrated for BUILDIUM

    is_trainedboolean | nullnullablerequired

    Whether the applicant pet is trained

    Notice

    This field is not currently hydrated for BUILDIUM

    is_vaccinatedboolean | nullnullablerequired

    Whether the applicant pet is vaccinated

    Notice

    This field is not currently hydrated for BUILDIUM

    namestring | nullnullablerequired

    The name associated with the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    notesstring | nullnullablerequired

    Notes associated with the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    typestring | nullnullablerequired

    The type associated with the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    weight_in_poundsnumber | nullnullablerequired

    The weight in pounds of the applicant pet

    Notice

    This field is not currently hydrated for BUILDIUM

    custom_data object | nullrequired
    object
  • ]
    • integration_idstringrequired

    The Propexo unique identifier for the integration

    Example: clwh5u07w000508me66sfh3um
    integration_vendorEnum14required

    The property management system of record

    Show 13 enum values
    BUILDIUMAPPFOLIOENTRATAMRIPROPERTYWAREPROPERTYWARE_RESTREALPAGEREALPAGE_RPXRENTMANAGERRENTVINERESMANYARDIYARDI_REST
    Example: BUILDIUM
    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 BUILDIUM

    Example: null
    screenings object[]required
    Notice

    This field is not currently hydrated for BUILDIUM

  • 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 BUILDIUM

    screening_datestring | nullnullablerequired

    The date the screening took place

    Notice

    This field is not currently hydrated for BUILDIUM

  • ]
  • ]

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": "cl9b1nqwe0003jsxq8ab1c2ac",
      "x_property_id": "cl9b1nqwe0001jsxq8ab1c2aa",
      "x_lead_id": null,
      "x_unit_id_preferred": null,
      "address_1_alternate": null,
      "address_1": null,
      "address_2_alternate": null,
      "address_2": null,
      "applications": [
        {
          "applicant_id": "clzct7ly60000opoz8kzn17lx",
          "application_id": "clzct7ly60000opoz8kzn17lx",
          "status_raw": "lease pending",
          "status_normalized": "APPROVED",
          "custom_data": "Unknown Type: object,null"
        }
      ],
      "city_alternate": null,
      "city": null,
      "country_alternate": null,
      "country": null,
      "custom_data": "Unknown Type: object,null",
      "date_of_birth": null,
      "email_1": "[email protected]",
      "email_2": null,
      "first_name": "Maya",
      "self_reported_income": [
        {
          "amount_in_cents": 325000,
          "amount_raw": "string",
          "type_normalized": null,
          "type_raw": null
        }
      ],
      "last_name": "Chen",
      "middle_name": null,
      "notes": null,
      "phone_1_type": "MOBILE",
      "phone_1": "(415) 555-0142",
      "phone_2_type": "HOME",
      "phone_2": "(415) 555-0198",
      "state_alternate": null,
      "state": null,
      "type_normalized": null,
      "type_raw": null,
      "zip_alternate": null,
      "zip": 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_declawed": true,
          "is_fixed": true,
          "is_service_animal": true,
          "is_trained": true,
          "is_vaccinated": true,
          "name": "string",
          "notes": "string",
          "type": "string",
          "weight_in_pounds": 0,
          "custom_data": "Unknown Type: object,null"
        }
      ],
      "integration_id": "clwh5u07w000508me66sfh3um",
      "integration_vendor": "BUILDIUM",
      "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"
        }
      ]
    }
  ]
}