Admin
Get all data diffs
GET
/
v1
/
admin
/
data-diffs

Get all data diffs

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
integration_vendor
optional enum
Show 9 enum values
integration_id
optional string
before
optional string
after
optional string
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 8 properties
Admin
Get log by ID
GET
/
v1
/
admin
/
job-logs
/
:job_log_id

Get a single log record by log ID. A log will only have a single associated job. This is different than querying by job ID, which could have multiple log entries (in the case of retry attempts for failed jobs).

Path parameters
job_log_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 9 properties
Admin
Get a link to the job log raw request and response data
GET
/
v1
/
admin
/
job-logs
/
:job_log_id
/
data

Get a link to the job log raw request and response data

Path parameters
job_log_id
string
Response
This endpoint returns an object.
Admin
Get logs
GET
/
v1
/
admin
/
logs
/
jobs

Get all logs

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
status
optional enum
Show 2 enum values
integration_id
optional string
job_type
optional string
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 9 properties
Admin
Get logs by job ID
GET
/
v1
/
admin
/
logs
/
jobs
/
:id

Get all logs for a job ID. This returns an array because jobs can have multiple log entries (in the case of retries on failed jobs).

Path parameters
id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
include_all_jobs
optional string
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 9 properties
Admin
Get all my integrations
GET
/
v1
/
admin
/
integrations

Get all my integrations

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
integration_vendor
optional enum
Show 9 enum values
is_archived
optional boolean
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 16 properties
Admin
Create an integration
POST
/
v1
/
admin
/
integrations

Create an integration

Request
This endpoint expects an object.
integration_vendor
enum

The integration vendor

Show 9 enum values
credentials
union

JSON encoded credentials for accessing the integration vendor API

Show 11 variants
name
string

The name of the integration

system
enum

The system the integration is associated with

Show 2 enum values
max_request_cadence
optional enum

Cadence at which to limit the max request frequency

Show 6 enum values
max_request_frequency
optional double

Number of request cadence units

max_job_concurrency
optional double

Maximum number of jobs that can be run at once for the integration. Please contact support to increase this limit.

active
optional boolean

The active state of the integration

base_url
optional string

DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API

Response
This endpoint returns an object.
result
object
Show 14 properties
Admin
Get all my users
GET
/
v1
/
admin
/
users

Get all my users

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
id
optional string
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 7 properties
Admin
Create a user
POST
/
v1
/
admin
/
users

Create a user

Request
This endpoint expects an object.
first_name
string

The first name of the user

last_name
string

The last name of the user

email
string

The email of the user

phone
optional string

The phone number of the user

roles
list of enums

The roles the user has assigned to them

Show 2 enum values
Response
This endpoint returns an object.
result
object
Show 7 properties
Admin
Get user by id
GET
/
v1
/
admin
/
users
/
:id

Get user by id

Path parameters
id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
optional object
Show 7 properties
Admin
Update a user
PUT
/
v1
/
admin
/
users
/
:id

Update a user

Path parameters
id
string
Request
This endpoint expects an object.
first_name
optional string

The first name of the user

last_name
optional string

The last name of the user

roles
optional list of enums

The roles the user has assigned to them

Show 2 enum values
Response
This endpoint returns an object.
result
object
Show 8 properties
Admin
Check the status of a write operation
GET
/
v1
/
admin
/
write-status
/
:root_job_id

Query for the status of a write operation created via the API. The status of the write operation, as well as any encountered errors, is provided.

Path parameters
root_job_id
string
Response
This endpoint returns an object.
write_status
enum

The status for the write operation. "SUCCESS" means that the write operation was seen as a complete success and the data has been written. "PARTIAL_SUCCESS" means that a portion of the write operation succeeded, but it was not fully successful. "FAILURE" means that the write operation completely failed."PENDING" means that the write operation is pending completion of any status.

Show 4 enum values
errors
list of strings

For "PARTIAL_SUCCESS" and "FAILURE" statuses, an array of error messages provided by the PMS may be present. This array could be incomplete if the PMS does not provide error messages.

Admin
Get integration by id
GET
/
v1
/
admin
/
integrations
/
:integration_id

Get integration by id

Path parameters
integration_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
optional object
Show 16 properties
Admin
Update an integration
PUT
/
v1
/
admin
/
integrations
/
:integration_id

Update an integration

Path parameters
integration_id
string
Request
This endpoint expects an object.
integration_vendor
optional enum

The integration vendor

Show 9 enum values
credentials
optional union

JSON encoded credentials for accessing the integration vendor API

Show 11 variants
name
optional string

The name of the integration

system
optional enum

The system the integration is associated with

Show 2 enum values
max_request_cadence
optional enum

Cadence at which to limit the max request frequency

Show 6 enum values
max_request_frequency
optional double

Number of request cadence units

max_job_concurrency
optional double

Maximum number of jobs that can be run at once for the integration. Please contact support to increase this limit.

active
optional boolean

The active state of the integration

base_url
optional string

DEPRECATED: see specific PMS credentials. Base URL for the integration vendor API

Response
This endpoint returns an object.
result
object
Show 12 properties
Admin
Delete an integration
DEL
/
v1
/
admin
/
integrations
/
:integration_id

Delete an integration

Path parameters
integration_id
string
Request
This endpoint expects an object.
Response
This endpoint returns an object.
success
boolean

Status of integration deletion

Admin
Get job schedules by integration id
GET
/
v1
/
admin
/
integrations
/
:integration_id
/
job-schedules

Get job schedules by integration id

Path parameters
integration_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 10 properties
Admin
Get job schedule by id
GET
/
v1
/
admin
/
integrations
/
:integration_id
/
job-schedules
/
:job_schedule_id

Get job schedule by id

Path parameters
integration_id
string
job_schedule_id
string
Response
This endpoint returns an object.
result
object
Show 10 properties
Amenities
Get all amenities
GET
/
v1
/
amenities

Get all amenities

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
x_unit_id
optional string
x_listing_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 20 properties
Amenities
Create amenity
POST
/
v1
/
amenities

Create an amenity for an integration.

Request
This endpoint expects an object.
integration_id
string
property_id
optional string

The Propexo unique identifier for the property

unit_id
optional string

The Propexo unique identifier for the unit

name
optional string

The name associated with the amenity

description
optional string

Description of the amenity

is_published
optional boolean

Whether the amenity should be published

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Amenities
Get an amenity by ID
GET
/
v1
/
amenities
/
:amenity_id

Get an amenity by ID

Path parameters
amenity_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 20 properties
Amenities
Update amenity
PUT
/
v1
/
amenities
/
:amenity_id

Update an amenity for an integration.

Path parameters
amenity_id
string
Request
This endpoint expects an object.
name
optional string

The name associated with the amenity

description
optional string

Description of the amenity

is_published
optional boolean

Whether the amenity should be published

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Amenities
Create Amenities | Units
POST
/
v1
/
amenities
/
units
/
:id

Create a unit amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.

Path parameters
id
string
Request
This endpoint expects an object.
amenity
string

The amenity name

custom_data
optional object

Custom data

integration_id
string
vendor
enum
Show 9 enum values
Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Amenities
Update amenities for unit
PUT
/
v1
/
amenities
/
units
/
:id

Update unit amenities for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.

Path parameters
id
string
Request
This endpoint expects an object.
features
optional list of enums

A list of unit amenities. Any existing amenities associated with the unit that are not submitted in the request will be removed from the unit

Show 53 enum values
Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Amenities
Create amenity for property
POST
/
v1
/
amenities
/
properties
/
:id

Create a property amenity for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.

Path parameters
id
string
Request
This endpoint expects an object.
amenity
string

The amenity name

custom_data
optional object

Custom data

integration_id
string
vendor
enum
Show 9 enum values
Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Amenities
Update amenities for property
PUT
/
v1
/
amenities
/
properties
/
:id

Update property amenities for any integration. This is a convenience endpoint that acts as a generic proxy for all amenity creation endpoints.

Path parameters
id
string
Request
This endpoint expects an object.
features
optional list of enums

A list of overall property amenities. Any previously saved values that are not submitted in the update request will be deleted

Show 63 enum values
included_in_rent
optional list of enums

A list of amenities that are included in rent. Any previously saved values that are not submitted in the update request will be deleted

Show 12 enum values
Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Applicants
Get all applicants
GET
/
v1
/
applicants

Get all applicants

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
x_unit_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 38 properties
Applicants
Create applicant
POST
/
v1
/
applicants

Create an applicant for an integration.

Request
This endpoint expects an object.
integration_id
string
property_id
optional string

The Propexo unique identifier for the property

unit_id
optional string

The Propexo unique identifier for the unit

originating_lead_source_id
optional string

The external ID of the lead source from the integration vendor

application_status
optional enum

The status associated with the application

Show 2 enum values
first_name
optional string

The first name associated with the applicant

last_name
optional string

The last name associated with the applicant

lease_term_in_months
optional string

The amount of months for the lease term

floorplan_id
optional string

The external ID of the floor plan from the integration vendor

move_in_date
optional datetime

The move-in date associated with the lease

leasing_agent_id
optional string

The external ID of the leasing agent from the integration vendor

email_1
optional string

The primary email address associated with the applicant

date_of_birth
optional datetime

The date of birth associated with the applicant

address_1
optional string

The first address line associated with the applicant

address_2
optional string

Second line of the street address for the applicant. This maps to the addressLine2 property of the Applicant's primary address.

city
optional string

The city associated with the applicant

state
optional string

The state associated with the applicant

zip
optional string

The zip code associated with the applicant

phone_1
optional string

'Primary phone number associated with the applicant

attachments
optional list of objects

Files to upload to the applicant.

Show 4 properties
events
optional list of objects

Array of events associated with this applicant

Show 12 properties
custom_data
optional object

Custom data

send_rental_application_email
optional boolean

Whether to send the new applicant an email with a link to the online application form

x_unit_id
optional string

The external ID of the unit from the integration vendor

phone_1_type
optional enum

Type of the primary phone number

Show 3 enum values
phone_2
optional string

'Secondary phone number associated with the applicant

phone_2_type
optional enum

Type of the secondary phone number

Show 3 enum values
x_property_id
optional string

The external ID of the property from the integration vendor

middle_name
optional string

The middle name associated with the applicant

lead_id
optional string

The Propexo unique identifier for the lead

application_date
optional datetime

The application date associated with the applicant

start_date
optional datetime

The start date associated with the lease

end_date
optional datetime

The end date associated with the lease

status
optional enum

The status associated with the application

Show 5 enum values
rent_amount_market_in_cents
optional double

The market rent amount in cents for the lease

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Applicants
Get an applicant by ID
GET
/
v1
/
applicants
/
:id

Get an applicant by ID

Path parameters
id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 38 properties
Applicants
Update applicant
PUT
/
v1
/
applicants
/
:id

Update an applicant for an integration.

Path parameters
id
string
Request
This endpoint expects an object.
last_name
optional string

The last name associated with the applicant

first_name
optional string

The first name associated with the applicant

x_unit_id
optional string

The external ID of the unit from the integration vendor

email_1
optional string

The primary email address associated with the applicant

phone_1
optional string

'Primary phone number associated with the applicant

phone_1_type
optional enum

Type of the primary phone number

Show 3 enum values
phone_2
optional string

'Secondary phone number associated with the applicant

phone_2_type
optional enum

Type of the secondary phone number

Show 3 enum values
applicant_id
optional string

The Propexo unique identifier for the applicant

application_id
optional string

The Propexo unique identifier for the application

unit_id
optional string

The Propexo unique identifier for the unit

property_id
optional string

The Propexo unique identifier for the property

originating_lead_source_id
optional string

The external ID of the lead source from the integration vendor

application_status
optional enum

The status associated with the application

Show 2 enum values
date_of_birth
optional datetime

The date of birth associated with the applicant

address_1
optional string

The first address line associated with the applicant

address_2
optional string

The second address line associated with the applicant

city
optional string

The city associated with the applicant

move_in_date
optional datetime

The move-in date associated with the lease

state
optional string

The state associated with the applicant

zip
optional string

The zip code associated with the applicant

lease_term_in_months
optional string

The amount of months for the lease term

leasing_agent_id
optional string

The external ID of the leasing agent from the integration vendor

floorplan_id
optional string

The external ID of the floor plan from the integration vendor

events
optional list of objects

Array of events associated with this applicant

Show 13 properties
x_property_id
optional string

The external ID of the property from the integration vendor

middle_name
optional string

The middle name associated with the applicant

country
optional string

The country associated with the applicant

application_date
optional datetime

The application date associated with the applicant

start_date
optional datetime

The start date associated with the applicant

end_date
optional datetime

The end date associated with the applicant

status
optional enum

The status associated with the applicant

Show 5 enum values
rent_amount_market_in_cents
optional double

The market rent amount in cents for the lease

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Applications
Get all applications
GET
/
v1
/
applications

Get all applications

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
x_unit_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 14 properties
Applications
Get an application by ID
GET
/
v1
/
applications
/
:id

Get an application by ID

Path parameters
id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 14 properties
Employees
Get all employees
GET
/
v1
/
employees

Get all employees

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
location_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 11 properties
Employees
Get an employee by ID
GET
/
v1
/
employees
/
:employee_id

Get an employee by ID

Path parameters
employee_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 11 properties
Events
Get all events
GET
/
v1
/
events

Get all events

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
property_id
optional string
lead_id
optional string
applicant_id
optional string
resident_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 19 properties
Events
Get an event by ID
GET
/
v1
/
events
/
:event_id

Get an event by ID

Path parameters
event_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 19 properties
Events
Create event for an applicant
POST
/
v1
/
events
/
applicants

Create an applicant event for an integration.

Request
This endpoint expects an object.
integration_id
string
applicant_id
optional string

The Propexo unique identifier for the applicant

event_type_id
optional string

The Propexo unique identifier for the event type

name
optional string

The name associated with the event type

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Events
Create event for a lead
POST
/
v1
/
events
/
leads

Create a lead event for an integration.

Request
This endpoint expects an object.
integration_id
string
lead_id
optional string

The Propexo unique identifier for the lead

event_name
optional enum

The name of the event in the PMS. These are specific to the PMS.

Show 13 enum values
event_datetime
optional datetime

The date of the prospect activity that has already occurred.

notes
optional string

Notes to associate with the event.

unit_id
optional string

The Propexo unique identifier for the unit

x_leasing_agent_id
optional string

The external ID of the leasing agent from the integration vendor

x_type_id
optional string

The PMS id for the activity type.

x_task_id
optional string

The PMS id for the task.

x_quote_id
optional string

The PMS id for the quote.

x_prc_id
optional string

The PMS id for the PRC.

x_guestcard_journal_id
optional string

The PMS id of the guest card journal for the event.

x_lost_traffic_reason_id
optional string

The PMS id for the lost traffic reason.

status
optional enum

The status of the activity.

Show 5 enum values
date_create
optional datetime

The date the event was created.

building_number
optional string

The building number of the specific prospect requesting the activity or appointment.

comments
optional string

The comments for a specific activity or appointment.

status_changed
optional boolean

Specifies whether the status of the activity is changed or updated.

is_task_completed
optional boolean

The identifier for whether the activity has been completed.

call_recording_url
optional string

The call recording URL of the appointment.

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Events
Create event for a resident
POST
/
v1
/
events
/
residents

Create a resident event for an integration.

Request
This endpoint expects an object.
integration_id
string
resident_id
optional string

The Propexo unique identifier for the resident

event_type_id
optional string

The Propexo unique identifier for the event type

name
optional string

The name associated with the event type

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Events
Get all event types
GET
/
v1
/
event-types

Get all event types

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
property_id
optional string
models
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 13 properties
Events
Get event type by ID
GET
/
v1
/
event-types
/
:event_type_id

Get event type by ID

Path parameters
event_type_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 13 properties
Files
Get all file types
GET
/
v1
/
file-types

Get all file types

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
property_id
optional string
type
optional string
models
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 14 properties
Files
Create file type
POST
/
v1
/
file-types

Create a file type for an integration.

Request
This endpoint expects an object.
integration_id
string
location_id
optional string

The Propexo unique identifier for the location

model
optional enum

The Propexo data model (e.g. units, residents, applicants, etc.) for which you are attempting to upload a file

Show 3 enum values
name
optional string

The name associated with the file type

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Files
Get file type by ID
GET
/
v1
/
file-types
/
:file_type_id

Get file type by ID

Path parameters
file_type_id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 14 properties
Leads
Get all leads
GET
/
v1
/
leads
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
location_id
optional string
x_unit_id
optional string
email_1
optional string
email_2
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 53 properties
Leads
Create lead
POST
/
v1
/
leads

Create a lead for an integration.

Request
This endpoint expects an object.
integration_id
string
last_name
optional string

The last name associated with the lead

first_name
optional string

The first name associated with the lead

email_1
optional string

The primary email address associated with the lead

phone_1
optional string

'Primary phone number associated with the lead. Defaults to the HOME phone type

phone_1_type
optional enum

Type of the primary phone number

Show 4 enum values
phone_2
optional string

'Secondary phone number associated with the lead. Defaults to the MOBILE phone type

phone_2_type
optional enum

Type of the secondary phone number

Show 4 enum values
address_1
optional string

The first address line associated with the lead

address_2
optional string

The second address line associated with the lead

city
optional string

The city associated with the lead

state
optional string

The state associated with the lead

zip
optional string

The zip code associated with the lead

country
optional string

The country associated with the lead

lead_source
optional string

The name of the source of the lead

property_id
optional string

The Propexo unique identifier for the property

x_lead_source_id
optional string

The external ID of the lead source from the integration vendor

middle_name
optional string

The middle name associated with the lead

date_of_birth
optional datetime

The date of birth associated with the lead

notes
optional string

Notes associated with the lead

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Leads
Get a lead by ID
GET
/
v1
/
leads
/
:id

Get a lead by ID

Path parameters
id
string
Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
object
Show 53 properties
Leads
Update lead
PUT
/
v1
/
leads
/
:id

Update a lead.

Path parameters
id
string
Request
This endpoint expects an object.
last_name
optional string

The last name associated with the lead

first_name
optional string

The first name associated with the lead

email_1
optional string

The primary email address associated with the lead

phone_1
optional string

'Primary phone number associated with the lead

phone_1_type
optional enum

Type of the primary phone number

Show 5 enum values
phone_2
optional string

'Secondary phone number associated with the lead

phone_2_type
optional enum

Type of the secondary phone number

Show 5 enum values
address_1
optional string

The first address line associated with the lead

address_2
optional string

The second address line associated with the lead

city
optional string

The city associated with the lead

state
optional string

The state associated with the lead

zip
optional string

The zip code associated with the lead

country
optional string

The country associated with the lead

lead_source
optional string

The name of the source of the lead

lead_id
optional string

The Propexo unique identifier for the lead

property_id
optional string

The Propexo unique identifier for the property

unit_id
optional string

The Propexo unique identifier for the unit

x_leasing_agent_id
optional string

The external ID of the leasing agent from the integration vendor

x_lead_source_id
optional string

The external ID of the lead source from the integration vendor

middle_name
optional string

The middle name associated with the lead

desired_lease_term_in_months
optional string

The amount of months for the lease term

target_move_in_date
optional string

The move-in date associated with the lead

desired_num_bedrooms
optional double

The desired number of bedrooms

desired_num_bathrooms
optional double

The desired number of bathrooms

desired_floor_plan_id
optional string

The external ID of the floor plan from the integration vendor

desired_max_rent_in_cents
optional double

The maximum rent cost the lead is looking to pay, in cents

desired_min_rent_in_cents
optional double

The minimum rent cost the lead is looking to pay, in cents

number_of_occupants
optional double

The number of occupants living in the unit

notes
optional string

Notes associated with the lead

events
optional list of objects

Array of events associated with this lead

Show 8 properties
desired_unit_number
optional string

The desired unit number

status
optional string

The status associated with the lead

desired_unit_type
optional string

The desired type of unit

Response
This endpoint returns an object.
job_id
string

The ID of the job created to handle this operation

data
object

Returned data from the operation. This is dependent on the vendor specific endpoint's returned data.

Leases
Get all leases
GET
/
v1
/
leases

Get all leases

Query parameters
order-by
optional string
offset
optional integer
limit
optional integer
x_id
optional string
x_property_id
optional string
x_unit_id
optional string
location_id
optional string
unit_id
optional string
resident_id
optional string
property_id
optional string
integration_id
optional string
integration_vendor
optional enum
Show 9 enum values
Response
This endpoint returns an object.
meta
object
Show 5 properties
results
list of objects
Show 34 properties
Leases
Create lease
POST
/
v1
/
leases

Create a lease for an integration.

Request
This endpoint expects an object.
integration_id
string