POST
/
units
/
find
/

You need to provide exact matches in the body of the request for the attributes of the units you are looking for.

You can provide either a list of group ids through the group_ids parameter or a list of group external references through the groups_external_refs attribute to filter the list of retrieved units down.

Do not provide both, as this will result in the request failing.

If no group_ids or group_external_refs are specified in the request body, the authenticated user will retrieve unit records for all groups they have access to.

Authorization
string
default: "none"required

The authentication token for your request.

​
Body

group_ids
[string]
default: "none"

The list of group ids for filtering the retrieved list.

groups_external_refs
[string]
default: "none"

The list of group external references for filtering the retrieved list.

external_ref
string
default: "none"

An external reference for the unit you want to find.

This is typically an identifier you may use for unit records in your own system.

identifier
string
default: "none"

The internal reference for the units you want to find.

has_flex_wall
boolean
default: "none"

Whether the units you want to retrieve are flex apartments or not.

number_of_bathrooms
integer
default: "none"

The number of bathrooms the units you want to find have.

number_of_bedrooms
integer
default: "none"

The number of bedrooms the units you want to find have.

sqft
integer
default: "none"

The square feet surface for the units you want to find.

unit_number
string
default: "none"

The number of the units you want to find.

address
object
default: "none"

Address information for the units you want to find.

after-id
string
default: "1"

The API returns a maximum of 100 records per call.

You can use this parameter to load the next set of records by passing in the value returned in the response, under last_id.

​
Response

last_id
integer

The last id in the set of results returned for this API call.

You can use this value in the after-id parameter to load the next set of results.

If there are no more results to load, this value will be -1.

units
[object]

The list of units retrieved by the endpoint

​
Errors

Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.

Status Code - 400

Missing Authorization header
{
   "error": {
    "type": "missing_authorization",
    "message": "Your request does not include an 'Authorization' header with a bearer token for your account."
  }
}

Status Code - 401

Expired Authorization header bearer token value
{
   "error": {
    "type": "expired_token",
    "message": "The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."
  }
}

Status Code - 401

Invalid Authorization header bearer token value
{
   "error": {
    "type": "invalid_authorization",
    "message": "The bearer token you have provided in the 'Authorization' header is invalid."
  }
}

Status Code - 400

Returned if both of the group_ids and groups_external_refs attributes are provided

Both group ids and external refs provided for the unit find operation
{
   "error": {
    "type": "both_group_identifiers_provided",
    "message": "You have provided both group ids and group external references for the find units operation. Please only provide one of the two."
  }
}

Status Code - 404

Returned if no unit records can be found matching the provided information.

No unit records found for the provided parameters
{
   "error": {
    "type": "not_found",
    "message": "There are no unit records matching the information provided."
  }
}
Lease webhook eventsCreate/Update Properties