Propify API Documentation (1.1.0)

Download OpenAPI specification:Download

admin

Admin

Get logs

Get all logs

SecurityAPIKEY_1 and APIKEY_2
Request
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
integer or null <int64> [ 0 .. 9007199254740991 ]
Default: 0

Can be used for paginating results

limit
integer or null <int64> [ 0 .. 250 ]
Default: 100

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

Responses
200

GET /v1/admin/logs/jobs Successful response

400

GET /v1/admin/logs/jobs Error response

get/v1/admin/logs/jobs
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
Get logs for job
Get all logs for job ID


SecurityAPIKEY_1 and APIKEY_2 
Request 
path Parameters
id
required
string
GET /v1/admin/logs/jobs/:id parameter


 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/admin/logs/jobs/:id Successful response


400
GET /v1/admin/logs/jobs/:id Error response


get/v1/admin/logs/jobs/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
amenities
Amenities


*Get amenities by unit id
SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/amenities/units/:id Successful response


400
GET /v1/amenities/units/:id Error response


get/v1/amenities/units/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create amenity for unit
Create an amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
amenity
required
string
The amenity name


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/amenities/units/:id Successful response


400
POST /v1/amenities/units/:id Error response


post/v1/amenities/units/{id}
Request samples 
application/json
{
  • "amenity": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
*Get amenities by property id
SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/amenities/properties/:id Successful response


400
GET /v1/amenities/properties/:id Error response


get/v1/amenities/properties/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create amenity for property
Create an amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
amenity
required
string
The amenity name


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/amenities/properties/:id Successful response


400
POST /v1/amenities/properties/:id Error response


post/v1/amenities/properties/{id}
Request samples 
application/json
{
  • "amenity": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
applicants
Applicants


Get all applicants
Get all applicants


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/applicants Successful response


400
GET /v1/applicants Error response


get/v1/applicants
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create applicant
Create an applicant for any integration. This is a convenience endpoint that acts as a generic proxy for all applicant creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_property_id
string
The property ID with which to associate the applicant


 
first_name
string
The first name of the applicant.


 
middle_name
string
The middle name of the applicant.


 
last_name
string
The last name of the applicant.


 
email_1
string <email> 
The primary email address for the applicant.


 
email_2
string <email> 
An alternate email address for the applicant.


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date of birth of the applicant.


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
adddress_1
string
First line of the applicant's primary address


 
address_2
string
Second line of the applicant's primary address


 
city
string
City of the applicant's primary address.


 
state
string
State of the applicant's primary address.


 
zip
string
Zip/Postal Code of the applicant's primary address.


 
country
string
Country of the applicant's primary address.


 
address_1_alternate
string
First line of the applicant's secondary/alternate street address.


 
address_2_alternate
string
Second line of the applicant's secondary/alternate street address.


 
city_alternate
string
City of the applicant's secondary/alternate address.


 
state_alternate
string
State of the applicant's secondary/alternate address.


 
zip_alternate
string
Zip/Postal Code of the applicant's secondary/alternate address.


 
country_alternate
string
Country of the applicant's secondary/alternate address.


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/applicants Successful response


400
POST /v1/applicants Error response


post/v1/applicants
Request samples 
application/json
{
  • "x_property_id": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email_1": "user@example.com",
  • "email_2": "user@example.com",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "adddress_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "address_1_alternate": "string",
  • "address_2_alternate": "string",
  • "city_alternate": "string",
  • "state_alternate": "string",
  • "zip_alternate": "string",
  • "country_alternate": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
Get an applicant by ID
Get an applicant by ID


SecurityAPIKEY_1 and APIKEY_2 
Request 
path Parameters
id
required
string
GET /v1/applicants/:id parameter


 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/applicants/:id Successful response


400
GET /v1/applicants/:id Error response


get/v1/applicants/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": {
    }
}
*Update applicant
Update an applicant for any integration. This is a convenience endpoint that acts as a generic proxy for all applicant update endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_property_id
string
The property ID with which to associate the applicant


 
first_name
string
The first name of the applicant.


 
middle_name
string
The middle name of the applicant.


 
last_name
string
The last name of the applicant.


 
email_1
string <email> 
The primary email address for the applicant.


 
email_2
string <email> 
An alternate email address for the applicant.


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date of birth of the applicant.


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
adddress_1
string
First line of the applicant's primary address


 
address_2
string
Second line of the applicant's primary address


 
city
string
City of the applicant's primary address.


 
state
string
State of the applicant's primary address.


 
zip
string
Zip/Postal Code of the applicant's primary address.


 
country
string
Country of the applicant's primary address.


 
address_1_alternate
string
First line of the applicant's secondary/alternate street address.


 
address_2_alternate
string
Second line of the applicant's secondary/alternate street address.


 
city_alternate
string
City of the applicant's secondary/alternate address.


 
state_alternate
string
State of the applicant's secondary/alternate address.


 
zip_alternate
string
Zip/Postal Code of the applicant's secondary/alternate address.


 
country_alternate
string
Country of the applicant's secondary/alternate address.


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
PUT /v1/applicants/:id Successful response


400
PUT /v1/applicants/:id Error response


put/v1/applicants/{id}
Request samples 
application/json
{
  • "x_property_id": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email_1": "user@example.com",
  • "email_2": "user@example.com",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "adddress_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "address_1_alternate": "string",
  • "address_2_alternate": "string",
  • "city_alternate": "string",
  • "state_alternate": "string",
  • "zip_alternate": "string",
  • "country_alternate": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
general-ledger
General Ledger


Get all general ledger invoices
Get all general ledger invoices


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/invoices Successful response


400
GET /v1/invoices Error response


get/v1/invoices
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
Get all general ledger transactions
Get all general ledger transactions


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/transactions Successful response


400
GET /v1/transactions Error response


get/v1/transactions
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create transaction
Create a transaction for any integration. This is a convenience endpoint that acts as a generic proxy for all transaction creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_id
required
string
The external ID from the source vendor


 
x_lease_id
string
The external lease ID from the source vendor


 
x_unit_id
string
The external unit ID from the source vendor


 
x_resident_id
string
The external resident ID from the source vendor


 
x_property_id
string
The external property ID from the source vendor


 
x_gl_account_id
string
The external general ledger account ID from the source vendor


 
amount_in_cents
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The amount of the transaction in cents.


 
transaction_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the transaction was received.


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
transaction_type
string
The type of transaction.


 Enum: "CHARGE" "PAYMENT" "CREDIT" "OTHER"  
payment_method
required
string
The payment method used in the transaction.


 Enum: "ACH" "CASH" "CHECK" "CREDIT_CARD" "DEBIT_CARD" "OTHER"  
notes
string
Notes.


 
integration_vendor
required
string
The property management system of record


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "PROPERTYWARE" "REALPAGE" "RENTMANAGER" "YARDI" "RENTVINE"  
Responses 
200
POST /v1/transactions Successful response


400
POST /v1/transactions Error response


post/v1/transactions
Request samples 
application/json
{
  • "x_id": "string",
  • "x_lease_id": "string",
  • "x_unit_id": "string",
  • "x_resident_id": "string",
  • "x_property_id": "string",
  • "x_gl_account_id": "string",
  • "amount_in_cents": -9007199254740991,
  • "transaction_date": "2019-08-24T14:15:22Z",
  • "transaction_type": "CHARGE",
  • "payment_method": "ACH",
  • "notes": "string",
  • "integration_vendor": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
leads
Leads


*Get all leads
SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/leads Successful response


400
GET /v1/leads Error response


get/v1/leads
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create lead
Create a lead for any integration. This is a convenience endpoint that acts as a generic proxy for all lead creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_id
required
string
The external ID from the source vendor


 
x_property_id
required
string
The external ID of the property from the source vendor


 
x_unit_id
required
string
The external ID of the unit from the source vendor


 
x_leasing_agent_id
string
The external ID of the leasing agent from the source vendor


 
status
string
The status of the lead


 
lead_source
string
The lead source


 
leasing_agent
string
The name of the leasing agent


 
ils
string
The name of the intetnet listing service


 
first_name
string
First name of the lead


 
middle_name
string
Middle name of the lead


 
last_name
string
Last name of the lead


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
Lead date of birth


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
address_1
string
Lead street address line 1


 
address_2
string
Lead street address line 2


 
city
string
Lead city


 
state
string
Lead state


 
zip
string
Lead zip code


 
phone_1
string
Lead phone number


 
phone_1_type
string
The type of phone number 1


 
phone_2
string
Lead phone number 2


 
phone_2_type
string
The type of phone number 2


 
email_1
string
Lead email address


 
email_2
string
Lead email address alternate


 
notes
string
Notes


 
target_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The target move in date


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
desired_unit_number
string
The unit number


 
desired_unit_type
string
The unit type


 
desired_min_square_ft
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired minimum square feet


 
desired_max_square_ft
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired maximum square feet


 
desired_floor_plan_id
string
The desired floor plan ID


 
desired_floor_plan_name
string
The desired floor plan name


 
desired_min_rent_in_cents
integer <int64>   [ 0 .. 9007199254740991 ] 
The desired minimum rent


 
desired_max_rent_in_cents
integer <int64>   [ 0 .. 9007199254740991 ] 
The desired maximum rent


 
desired_num_bedrooms
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The desired number of bedrooms


 
desired_num_bathrooms
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired number of bathrooms


 
desired_lease_term_in_months
string
The desired lease term


 
number_of_occupants
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The number of occupants


 
desired_amenities
Array of strings
The desired amenities


 
required
Array of objects
 
Array of objects
The events associated with the lead


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/leads Successful response


400
POST /v1/leads Error response


post/v1/leads
Request samples 
application/json
{
  • "x_id": "string",
  • "x_property_id": "string",
  • "x_unit_id": "string",
  • "x_leasing_agent_id": "string",
  • "status": "string",
  • "lead_source": "string",
  • "leasing_agent": "string",
  • "ils": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "phone_1": "string",
  • "phone_1_type": "string",
  • "phone_2": "string",
  • "phone_2_type": "string",
  • "email_1": "string",
  • "email_2": "string",
  • "notes": "string",
  • "target_move_in_date": "2019-08-24T14:15:22Z",
  • "desired_unit_number": "string",
  • "desired_unit_type": "string",
  • "desired_min_square_ft": 5e-324,
  • "desired_max_square_ft": 5e-324,
  • "desired_floor_plan_id": "string",
  • "desired_floor_plan_name": "string",
  • "desired_min_rent_in_cents": 0,
  • "desired_max_rent_in_cents": 0,
  • "desired_num_bedrooms": -9007199254740991,
  • "desired_num_bathrooms": 5e-324,
  • "desired_lease_term_in_months": "string",
  • "number_of_occupants": -9007199254740991,
  • "desired_amenities": [
    ],
  • "pets": [
    ],
  • "events": [
    ],
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
*Update lead
Update a lead for any integration. This is a convenience endpoint that acts as a generic proxy for all lead update endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
id
required
string
The propify unique identifier for the lead


 
x_property_id
string
The external ID of the property from the source vendor


 
x_unit_id
string
The external ID of the unit from the source vendor


 
x_leasing_agent_id
string
The external ID of the leasing agent from the source vendor


 
status
string
The status of the lead


 
lead_source
string
The lead source


 
leasing_agent
string
The name of the leasing agent


 
ils
string
The name of the intetnet listing service


 
first_name
string
First name of the lead


 
middle_name
string
Middle name of the lead


 
last_name
string
Last name of the lead


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
Lead date of birth


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
address_1
string
Lead street address line 1


 
address_2
string
Lead street address line 2


 
city
string
Lead city


 
state
string
Lead state


 
zip
string
Lead zip code


 
phone_1
string
Lead phone number


 
phone_1_type
string
The type of phone number 1


 
phone_2
string
Lead phone number 2


 
phone_2_type
string
The type of phone number 2


 
email_1
string
Lead email address


 
email_2
string
Lead email address alternate


 
notes
string
Notes


 
target_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The target move in date


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
desired_unit_number
string
The unit number


 
desired_unit_type
string
The unit type


 
desired_min_square_ft
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired minimum square feet


 
desired_max_square_ft
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired maximum square feet


 
desired_floor_plan_id
string
The desired floor plan ID


 
desired_floor_plan_name
string
The desired floor plan name


 
desired_min_rent_in_cents
integer <int64>   [ 0 .. 9007199254740991 ] 
The desired minimum rent


 
desired_max_rent_in_cents
integer <int64>   [ 0 .. 9007199254740991 ] 
The desired maximum rent


 
desired_num_bedrooms
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The desired number of bedrooms


 
desired_num_bathrooms
number <double>   [ 5e-324 .. 1.7976931348623157e+308 ] 
The desired number of bathrooms


 
desired_lease_term_in_months
string
The desired lease term


 
number_of_occupants
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The number of occupants


 
desired_amenities
Array of strings
The desired amenities


 
required
Array of objects
 
Array of objects
The events associated with the lead


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
PUT /v1/leads Successful response


400
PUT /v1/leads Error response


put/v1/leads
Request samples 
application/json
{
  • "id": "string",
  • "x_property_id": "string",
  • "x_unit_id": "string",
  • "x_leasing_agent_id": "string",
  • "status": "string",
  • "lead_source": "string",
  • "leasing_agent": "string",
  • "ils": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "phone_1": "string",
  • "phone_1_type": "string",
  • "phone_2": "string",
  • "phone_2_type": "string",
  • "email_1": "string",
  • "email_2": "string",
  • "notes": "string",
  • "target_move_in_date": "2019-08-24T14:15:22Z",
  • "desired_unit_number": "string",
  • "desired_unit_type": "string",
  • "desired_min_square_ft": 5e-324,
  • "desired_max_square_ft": 5e-324,
  • "desired_floor_plan_id": "string",
  • "desired_floor_plan_name": "string",
  • "desired_min_rent_in_cents": 0,
  • "desired_max_rent_in_cents": 0,
  • "desired_num_bedrooms": -9007199254740991,
  • "desired_num_bathrooms": 5e-324,
  • "desired_lease_term_in_months": "string",
  • "number_of_occupants": -9007199254740991,
  • "desired_amenities": [
    ],
  • "pets": [
    ],
  • "events": [
    ],
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
leases
Leases


Get all leases
Get all leases


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
id
string <cuid> 
The Propify lease id.


 
x_id
string
The external lease id.


 
x_propery_id
string
The external property id.


 
integration_vendor
string
The integration vendor for the lease.


 Enum: "BUILDIUM" "ENTRATA" "PROPERTYWARE" "REALPAGE" "RENTMANAGER" "YARDI" "RENTVINE"  
Responses 
200
GET /v1/leases Successful response


400
GET /v1/leases Error response


get/v1/leases
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create lease
Create a lease for any integration. This is a convenience endpoint that acts as a generic proxy for all lease creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_property_id
string
The external property ID from the source vendor


 
x_resident_id
string
The external resident ID from the source vendor


 
x_unit_id
string
The external unit ID from the source vendor


 
rent_amount_in_cents
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The rent amount in cents


 
rent_due_day
integer <int64>   [ 0 .. 9007199254740991 ] 
The day of the month the rent is due


 
deposit_amount
string
The deposit amount in cents


 
deposit_amount_amount_in_cents
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The deposit amount in cents


 
deposit_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the deposit was received


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
signature_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease was signed


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
start_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease starts


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
end_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease ends


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
application_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the application was submitted


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
scheduled_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident is scheduled to move in


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
scheduled_move_out_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident is scheduled to move out


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
realized_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident actually moved in


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
realized_move_out_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident actually moved out


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
status
string
The status of the lease


 
type
string
The type of lease


 
term
string
The lease term


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/leases Successful response


400
POST /v1/leases Error response


post/v1/leases
Request samples 
application/json
{
  • "x_property_id": "string",
  • "x_resident_id": "string",
  • "x_unit_id": "string",
  • "rent_amount_in_cents": -9007199254740991,
  • "rent_due_day": 0,
  • "deposit_amount": "string",
  • "deposit_amount_amount_in_cents": -9007199254740991,
  • "deposit_date": "2019-08-24T14:15:22Z",
  • "signature_date": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "application_date": "2019-08-24T14:15:22Z",
  • "scheduled_move_in_date": "2019-08-24T14:15:22Z",
  • "scheduled_move_out_date": "2019-08-24T14:15:22Z",
  • "realized_move_in_date": "2019-08-24T14:15:22Z",
  • "realized_move_out_date": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "type": "string",
  • "term": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
Get a lease by ID
Get a lease by ID


SecurityAPIKEY_1 and APIKEY_2 
Request 
path Parameters
id
required
string
GET /v1/leases/:id parameter


 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/leases/:id Successful response


400
GET /v1/leases/:id Error response


get/v1/leases/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": {
    }
}
*Update lease
Update a lease for any integration. This is a convenience endpoint that acts as a generic proxy for all lease update endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_property_id
string
The external property ID from the source vendor


 
x_resident_id
string
The external resident ID from the source vendor


 
x_unit_id
string
The external unit ID from the source vendor


 
rent_amount_in_cents
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The rent amount in cents


 
rent_due_day
integer <int64>   [ 0 .. 9007199254740991 ] 
The day of the month the rent is due


 
deposit_amount
string
The deposit amount in cents


 
deposit_amount_amount_in_cents
integer <int64>   [ -9007199254740991 .. 9007199254740991 ] 
The deposit amount in cents


 
deposit_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the deposit was received


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
signature_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease was signed


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
start_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease starts


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
end_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the lease ends


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
application_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the application was submitted


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
scheduled_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident is scheduled to move in


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
scheduled_move_out_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident is scheduled to move out


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
realized_move_in_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident actually moved in


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
realized_move_out_date
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date the resident actually moved out


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
status
string
The status of the lease


 
type
string
The type of lease


 
term
string
The lease term


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
PUT /v1/leases/:id Successful response


400
PUT /v1/leases/:id Error response


put/v1/leases/{id}
Request samples 
application/json
{
  • "x_property_id": "string",
  • "x_resident_id": "string",
  • "x_unit_id": "string",
  • "rent_amount_in_cents": -9007199254740991,
  • "rent_due_day": 0,
  • "deposit_amount": "string",
  • "deposit_amount_amount_in_cents": -9007199254740991,
  • "deposit_date": "2019-08-24T14:15:22Z",
  • "signature_date": "2019-08-24T14:15:22Z",
  • "start_date": "2019-08-24T14:15:22Z",
  • "end_date": "2019-08-24T14:15:22Z",
  • "application_date": "2019-08-24T14:15:22Z",
  • "scheduled_move_in_date": "2019-08-24T14:15:22Z",
  • "scheduled_move_out_date": "2019-08-24T14:15:22Z",
  • "realized_move_in_date": "2019-08-24T14:15:22Z",
  • "realized_move_out_date": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "type": "string",
  • "term": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
listings
Listings


*Get all listings
SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/listings Successful response


400
GET /v1/listings Error response


get/v1/listings
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create listing
Create a listing for any integration. This is a convenience endpoint that acts as a generic proxy for all listing creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
unit_id
required
string
The propify unit id - cuid()


 
rent_amount_in_cents
required
integer <int64>   [ 0 .. 9007199254740991 ] 
The rent amount in cents


 
deposit_amount_in_cents
required
integer <int64>   [ 0 .. 9007199254740991 ] 
The deposit amount in cents


 
lease_terms
string
The lease terms


 
available_date
required
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The available date


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
contact_id
required
string
The propify contact id - cuid()


 
is_managed_external
required
boolean
Whether the listing is managed externally


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/listings Successful response


400
POST /v1/listings Error response


post/v1/listings
Request samples 
application/json
{
  • "unit_id": "string",
  • "rent_amount_in_cents": 0,
  • "deposit_amount_in_cents": 0,
  • "lease_terms": "string",
  • "available_date": "2019-08-24T14:15:22Z",
  • "contact_id": "string",
  • "is_managed_external": true,
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
properties
Properties


Get all properties
Get all properties


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
id
string <cuid> 
The Propify property id.


 
x_id
string
The external property id.


 
integration_vendor
string
The integration vendor for the property.


 Enum: "BUILDIUM" "ENTRATA" "PROPERTYWARE" "REALPAGE" "RENTMANAGER" "YARDI" "RENTVINE"  
Responses 
200
GET /v1/properties Successful response


400
GET /v1/properties Error response


get/v1/properties
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
rent-payment-history
Rent Payment History


residents
Residents


Get all residents
Get all residents


SecurityAPIKEY_1 and APIKEY_2 
Request 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/residents Successful response


400
GET /v1/residents Error response


get/v1/residents
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}
*Create resident
Create a resident for any integration. This is a convenience endpoint that acts as a generic proxy for all resident creation endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_lease_id
string
The lease ID with which to associate the resident


 
first_name
string
The first name of the resident.


 
middle_name
string
The middle name of the resident.


 
last_name
string
The last name of the resident.


 
email_1
string <email> 
The primary email address for the resident.


 
email_2
string <email> 
An alternate email address for the resident.


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date of birth of the resident.


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
adddress_1
string
First line of the resident's primary address


 
address_2
string
Second line of the resident's primary address


 
city
string
City of the resident's primary address.


 
state
string
State of the resident's primary address.


 
zip
string
Zip/Postal Code of the resident's primary address.


 
country
string
Country of the resident's primary address.


 
address_1_alternate
string
First line of the resident's secondary/alternate street address.


 
address_2_alternate
string
Second line of the resident's secondary/alternate street address.


 
city_alternate
string
City of the resident's secondary/alternate address.


 
state_alternate
string
State of the resident's secondary/alternate address.


 
zip_alternate
string
Zip/Postal Code of the resident's secondary/alternate address.


 
country_alternate
string
Country of the resident's secondary/alternate address.


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
POST /v1/residents Successful response


400
POST /v1/residents Error response


post/v1/residents
Request samples 
application/json
{
  • "x_lease_id": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email_1": "user@example.com",
  • "email_2": "user@example.com",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "adddress_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "address_1_alternate": "string",
  • "address_2_alternate": "string",
  • "city_alternate": "string",
  • "state_alternate": "string",
  • "zip_alternate": "string",
  • "country_alternate": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
Get a resident by ID
Get a resident by ID


SecurityAPIKEY_1 and APIKEY_2 
Request 
path Parameters
id
required
string
GET /v1/residents/:id parameter


 
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
integer or null <int64>   [ 0 .. 9007199254740991 ] 
 Default:  0
Can be used for paginating results


 
limit
integer or null <int64>   [ 0 .. 250 ] 
 Default:  100
A number between 1 and 250 to determine the number of results to return in a single query


 
Responses 
200
GET /v1/residents/:id Successful response


400
GET /v1/residents/:id Error response


get/v1/residents/{id}
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": {
    }
}
*Update resident
Update a resident for any integration. This is a convenience endpoint that acts as a generic proxy for all resident update endpoints.


SecurityAPIKEY_1 and APIKEY_2 
Request 
Request Body schema: application/json
x_lease_id
string
The lease ID with which to associate the resident


 
first_name
string
The first name of the resident.


 
middle_name
string
The middle name of the resident.


 
last_name
string
The last name of the resident.


 
email_1
string <email> 
The primary email address for the resident.


 
email_2
string <email> 
An alternate email address for the resident.


 
date_of_birth
string <date-time> ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?...
The date of birth of the resident.


 
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
adddress_1
string
First line of the resident's primary address


 
address_2
string
Second line of the resident's primary address


 
city
string
City of the resident's primary address.


 
state
string
State of the resident's primary address.


 
zip
string
Zip/Postal Code of the resident's primary address.


 
country
string
Country of the resident's primary address.


 
address_1_alternate
string
First line of the resident's secondary/alternate street address.


 
address_2_alternate
string
Second line of the resident's secondary/alternate street address.


 
city_alternate
string
City of the resident's secondary/alternate address.


 
state_alternate
string
State of the resident's secondary/alternate address.


 
zip_alternate
string
Zip/Postal Code of the resident's secondary/alternate address.


 
country_alternate
string
Country of the resident's secondary/alternate address.


 
integration_id
required
string <cuid> 
 
vendor
required
string
 Enum: "BUILDIUM" "ENTRATA" "RENTMANAGER" "YARDI" "REALPAGE" "RENTVINE" "PROPERTYWARE"  
Responses 
200
PUT /v1/residents/:id Successful response


400
PUT /v1/residents/:id Error response


put/v1/residents/{id}
Request samples 
application/json
{
  • "x_lease_id": "string",
  • "first_name": "string",
  • "middle_name": "string",
  • "last_name": "string",
  • "email_1": "user@example.com",
  • "email_2": "user@example.com",
  • "date_of_birth": "2019-08-24T14:15:22Z",
  • "adddress_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "address_1_alternate": "string",
  • "address_2_alternate": "string",
  • "city_alternate": "string",
  • "state_alternate": "string",
  • "zip_alternate": "string",
  • "country_alternate": "string",
  • "integration_id": "string",
  • "vendor": "BUILDIUM"
}
Response samples 
application/json
{ }
unit-pricing
Unit Pricing


*Get all unit pricing
SecurityAPIKEY_1 and APIKEY_2 
Responses 
200
GET /v1/unit-pricing Successful response


400
GET /v1/unit-pricing Error response


get/v1/unit-pricing
Request samples 
Response samples 
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}