You need to provide at least one search parameter in your request to find leases.All date fields included in the query parameters need to be specified as ISO8601-formatted date strings.Date fields should follow a “YYYY-MM-DD” format.
This endpoint allows you to find leases based on a number of parameters.You can retrieve all leases for a given group or list of groups by providing their IDs.You can retrieve all leases for a specific unit by passing the internal ID or the external reference.You can retrieve leases for a given address, with the possibility of narrowing or broadening the search by providing more or less address data.You can provide either group ids through the group_ids parameter or group external references through the group_external_refs attribute to filter the list of retrieved leases 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, the authenticated user will retrieve lease records for all groups they have access to.
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 pagination.next_cursor.
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.Status Code - 400
Missing Authorization header
Copy
Ask AI
{ "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
Copy
Ask AI
{ "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
Copy
Ask AI
{ "error": { "type": "invalid_authorization", "message": "The bearer token you have provided in the 'Authorization' header is invalid." }}
Status Code - 400
No search parameters provided
Copy
Ask AI
{ "error": { "type": "no_search_parameters", "message": "At least one search parameter is required to find leases." }}
Status Code - 400
Both group id and external ref provided for the tenant find operation
Copy
Ask AI
{ "error": { "type": "both_group_identifiers_provided", "message": "You have provided both a group id and group external reference for the find leases operation. Please only provide one of the two." }}
Status Code - 404Returned if no lease records could not be found.
No lease records found for the provided parameters
Copy
Ask AI
{ "error": { "type": "not_found", "message": "There are no lease records matching the provided parameters." }}
Copy
Ask AI
curl --location --request GET 'https://api.travtus.com/leases/?start_date=2023-01-17' \--header 'Authorization: bearer <token>'