Resident by ID - Propify Documentation

{
  "meta": {
    "offset": "integer",
    "limit": "integer",
    "orderBy": [
      {}
    ],
    "hasMore": [
      "boolean",
      "null"
    ],
    "total": "number"
  },
  "results": {
    "id": "string",
    "created_at": "string",
    "updated_at": "string",
    "x_id": "string",
    "x_lease_id": [
      "string",
      "null"
    ],
    "leases_meta_data": [
      {
        "lease_id": "string",
        "x_resident_type": [
          "string",
          "null"
        ],
        "resident_type_normalized": "PRIMARY"
      }
    ],
    "address_1_alternate": [
      "string",
      "null"
    ],
    "address_1": [
      "string",
      "null"
    ],
    "address_2_alternate": [
      "string",
      "null"
    ],
    "address_2": [
      "string",
      "null"
    ],
    "balance_in_cents": [
      "number",
      "null"
    ],
    "city_alternate": [
      "string",
      "null"
    ],
    "city": [
      "string",
      "null"
    ],
    "country_alternate": [
      "string",
      "null"
    ],
    "country": [
      "string",
      "null"
    ],
    "custom_data": {},
    "date_of_birth": [
      "string",
      "null"
    ],
    "email_1": [
      "string",
      "null"
    ],
    "email_2": [
      "string",
      "null"
    ],
    "first_name": [
      "string",
      "null"
    ],
    "is_employee": [
      "boolean",
      "null"
    ],
    "last_name": [
      "string",
      "null"
    ],
    "late_balance_in_cents": [
      "number",
      "null"
    ],
    "middle_name": [
      "string",
      "null"
    ],
    "notes": [
      "string",
      "null"
    ],
    "phone_1_type": "FAX",
    "phone_1": [
      "string",
      "null"
    ],
    "phone_2_type": "FAX",
    "phone_2": [
      "string",
      "null"
    ],
    "state_alternate": [
      "string",
      "null"
    ],
    "state": [
      "string",
      "null"
    ],
    "zip_alternate": [
      "string",
      "null"
    ],
    "zip": [
      "string",
      "null"
    ],
    "integration_id": "string",
    "integration_vendor": "string",
    "property_id": "string"
  }
}

Path Parameters

idrequired

string

The ID of the resource.

idrequired

string

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=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

Response

metarequired

object

resultsrequired

object

idrequired

string

The Propify unique identifier for the resident

created_atrequired

string

The date record first entered Propify

updated_atrequired

string

The date record was last updated in Propify

x_idrequired

string

The external ID from the integration vendor

x_lease_idrequired

string | null

Deprecated. Use lease_ids instead

leases_meta_data

array

Known associated lease meta data

address_1_alternaterequired

string | null

Resident street address line 1 alternate

address_1required

string | null

Resident street address line 1

address_2_alternaterequired

string | null

Resident street address line 2 alternate

address_2required

string | null

Resident street address line 2

balance_in_centsrequired

number | null

The rent balance owed

city_alternaterequired

string | null

Resident city alternate

cityrequired

string | null

Resident city

country_alternaterequired

string | null

Resident country alternate

countryrequired

string | null

Resident country

custom_datarequired

object | null

Custom data

date_of_birthrequired

string | null

Resident date of birth

email_1required

string | null

Resident email address

email_2required

string | null

Resident email address alternate

first_namerequired

string | null

First name of the resident

is_employeerequired

boolean | null

Is the resident an employee

last_namerequired

string | null

Last name of the resident

late_balance_in_centsrequired

number | null

The past due rent balance owed

middle_namerequired

string | null

Middle name of the resident

notesrequired

string | null

Notes

phone_1_typerequired

string | null

The type of phone number 1

Available options:

FAX,

HOME,

MOBILE,

OTHER,

WORK

phone_1required

string | null

Resident phone number

phone_2_typerequired

string | null

The type of phone number 2

Available options:

FAX,

HOME,

MOBILE,

OTHER,

WORK

phone_2required

string | null

Resident phone number 2

state_alternaterequired

string | null

Resident state alternate

staterequired

string | null

Resident state

zip_alternaterequired

string | null

Resident zip code alternate

ziprequired

string | null

Resident zip code

integration_idrequired

string

The Propify unique identifier for the integration

integration_vendorrequired

string

The property management system of record

property_idrequired

string

The Propify unique identifier for the property

API Reference

​Path Parameters

​Query Parameters

​Response

Path Parameters

Query Parameters

Response