Leads - Propify Documentation

{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": [
    {
      "id": "string",
      "created_at": "string",
      "updated_at": "string",
      "x_created_at": [
        "string",
        "null"
      ],
      "x_guestcard_id": [
        "string",
        "null"
      ],
      "x_id": "string",
      "x_leasing_agent_id": [
        "string",
        "null"
      ],
      "x_property_id": "string",
      "x_unit_id": [
        "string",
        "null"
      ],
      "x_updated_at": [
        "string",
        "null"
      ],
      "x_lead_source_id": [
        "string",
        "null"
      ],
      "address_1": [
        "string",
        "null"
      ],
      "address_2": [
        "string",
        "null"
      ],
      "city": [
        "string",
        "null"
      ],
      "country": [
        "string",
        "null"
      ],
      "custom_data": {},
      "date_of_birth": [
        "string",
        "null"
      ],
      "desired_amenities": [
        "string",
        "null"
      ],
      "desired_floor_plan_id": [
        "string",
        "null"
      ],
      "desired_floor_plan_name": [
        "string",
        "null"
      ],
      "desired_lease_term_in_months": [
        "string",
        "null"
      ],
      "desired_max_rent_in_cents": [
        "number",
        "null"
      ],
      "desired_max_square_ft": [
        "number",
        "null"
      ],
      "desired_min_rent_in_cents": [
        "number",
        "null"
      ],
      "desired_min_square_ft": [
        "number",
        "null"
      ],
      "desired_num_bathrooms": [
        "number",
        "null"
      ],
      "desired_num_bedrooms": [
        "integer",
        "null"
      ],
      "desired_unit_number": [
        "string",
        "null"
      ],
      "desired_unit_type": [
        "string",
        "null"
      ],
      "email_1": [
        "string",
        "null"
      ],
      "email_2": [
        "string",
        "null"
      ],
      "first_name": [
        "string",
        "null"
      ],
      "ils": [
        "string",
        "null"
      ],
      "last_name": [
        "string",
        "null"
      ],
      "lead_source": [
        "string",
        "null"
      ],
      "leasing_agent": [
        "string",
        "null"
      ],
      "middle_name": [
        "string",
        "null"
      ],
      "notes": [
        "string",
        "null"
      ],
      "number_of_occupants": [
        "integer",
        "null"
      ],
      "pet_details": [
        "string",
        "null"
      ],
      "phone_1_type": [
        "string",
        "null"
      ],
      "phone_1": [
        "string",
        "null"
      ],
      "phone_2_type": [
        "string",
        "null"
      ],
      "phone_2": [
        "string",
        "null"
      ],
      "state": [
        "string",
        "null"
      ],
      "status": [
        "string",
        "null"
      ],
      "target_move_in_date": [
        "string",
        "null"
      ],
      "zip": [
        "string",
        "null"
      ],
      "property_id": "string",
      "integration_id": "string",
      "integration_vendor": "string"
    }
  ]
}

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=vendor:asc,created_at:desc

offset

Default: 0

integernull

Can be used for paginating results

limit

Default: 100

integernull

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

x_id

string

The external lead id

x_property_id

string

The external property id

x_unit_id

string

The external unit id

email_1

string

Lead email address

email_2

string

Lead email address alternate

property_id

string

The Propify property id

integration_id

string

The Propify integration id

integration_vendor

string

The integration vendor for the lead.

Response

metarequired

object

resultsrequired

array

idrequired

string

The Propify unique identifier for the lead

created_atrequired

string

The date record first entered Propify

updated_atrequired

string

The date record was last updated in Propify

x_created_atrequired

string | null

The date the record first entered the integration vendor

x_guestcard_idrequired

string | null

The external ID of the guestcard from the integration vendor

x_idrequired

string

The external ID from the integration vendor

x_leasing_agent_idrequired

string | null

The external ID of the leasing agent from the integration vendor

x_property_idrequired

string

The external ID of the property from the integration vendor

x_unit_idrequired

string | null

The external ID of the unit from the integration vendor

x_updated_atrequired

string | null

The date the record was last updated in the integration vendor

x_lead_source_idrequired

string | null

The external ID of the lead source from the integration vendor

address_1required

string | null

Lead street address line 1

address_2required

string | null

Lead street address line 2

cityrequired

string | null

Lead city

countryrequired

string | null

Lead country

custom_datarequired

object | null

Custom data

date_of_birthrequired

string | null

Lead date of birth

desired_amenitiesrequired

string | null

The desired amenities

desired_floor_plan_idrequired

string | null

The desired floor plan ID

desired_floor_plan_namerequired

string | null

The desired floor plan name

desired_lease_term_in_monthsrequired

string | null

The desired lease term

desired_max_rent_in_centsrequired

number | null

The desired maximum rent

desired_max_square_ftrequired

number | null

The desired maximum square feet

desired_min_rent_in_centsrequired

number | null

The desired minimum rent

desired_min_square_ftrequired

number | null

The desired minimum square feet

desired_num_bathroomsrequired

number | null

The desired number of bathrooms

desired_num_bedroomsrequired

integer | null

The desired number of bedrooms

desired_unit_numberrequired

string | null

The unit number

desired_unit_typerequired

string | null

The unit type

email_1required

string | null

Lead email address

email_2required

string | null

Lead email address alternate

first_namerequired

string | null

First name of the lead

ilsrequired

string | null

The name of the Internet listing service

last_namerequired

string | null

Last name of the lead

lead_sourcerequired

string | null

The lead source

leasing_agentrequired

string | null

The name of the leasing agent

middle_namerequired

string | null

Middle name of the lead

notesrequired

string | null

Notes

number_of_occupantsrequired

integer | null

The number of occupants

pet_detailsrequired

string | null

Details about the lead's pets

phone_1_typerequired

string | null

The type of phone number 1

phone_1required

string | null

Lead phone number

phone_2_typerequired

string | null

The type of phone number 2

phone_2required

string | null

Lead phone number 2

staterequired

string | null

Lead state

statusrequired

string | null

The status of the lead

target_move_in_daterequired

string | null

The target move in date

ziprequired

string | null

Lead zip code

property_idrequired

string

The Propify unique identifier for the property

integration_idrequired

string

The Propify unique identifier for the integration

integration_vendorrequired

string

The property management system of record

API Reference

​Query Parameters

​Response

Query Parameters

Response