Find Tenants

curl --location --request POST 'https://api.travtus.com/leases/tenants/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
    "min_move_in_date": "2020-01-17",
    "identifier": "lease-1"
}'

{
  "tenants": [
    {
      "identifier": "internal-id-1",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "identifier": "internal-id-2",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567890"
    }
  ],
  "last_id": 5
}

POST

leases

tenants

curl --location --request POST 'https://api.travtus.com/leases/tenants/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
    "min_move_in_date": "2020-01-17",
    "identifier": "lease-1"
}'

{
  "tenants": [
    {
      "identifier": "internal-id-1",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "identifier": "internal-id-2",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567890"
    }
  ],
  "last_id": 5
}

All date fields included in the body parameters need to be specified as ISO8601-formatted date strings. Date fields should follow a “YYYY-MM-DD” format.

Example use cases

This endpoint allows you to find tenants based on lease parameters. You can retrieve tenants for a lease with a specific ID. You can retrieve tenants for all leases within a minimum (min_move_in_date) and/or maximum (max_move_in_date) move in date range. You can retrieve tenants for leases belonging specific group via the group’s ID. You can retrieve tenants with a lease at a particular address, with the possibility of narrowing or broadening the search by providing more or less address data. You can provide either a group id through the group_id parameter or a group external reference through the group_external_ref attribute to filter the list of retrieved tenants down. Do not provide both, as this will result in the request failing. If no group_id or group_external_ref are specified in the request body, the authenticated user will retrieve tenant records for all groups they have access to.

string

default:"none"

required

The authentication token for your request

Body

string

default:"none"

The identifier of a lease to find the tenants for.

string

default:"none"

The lower boundary for the lease’s tenants’ move in date.

string

default:"none"

The upper boundary for the lease’s tenants’ move in date.

string

default:"none"

The id of the group the lease and tenants belong to.

string

default:"none"

The external reference of the group the lease and tenants belong to.

object

default:"none"

The address of a lease to retrieve tenants for.

Show child attributes

string

The name of the addresses’ building.

string

The first line of the address.

string

The second line of the address.

string

The address’ city.

string

The address’ country.

string

The address’ state.

string

The address’ postal code.

float

The address’ latitude.

float

The address’ longitude.

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

string

A list of the tenants that have been retrieved.

Show properties

string

default:"none"

The internal identifier for the retrieved tenant.

string

The email adddress of the retrieved tenant.

string

The first name of the retrieved tenant.

string

The last name of the retrieved tenant..

string

An external reference for the retrieved tenant.This is typically an identifier you may use for person records in your own system.

string

The phone number of the retrieved tenant.

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.

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 a group id and group_external_ref are provided

Both group id and external ref provided for the tenant find operation

{
   "error": {
    "type": "both_group_identifiers_provided",
    "message": "You have provided both a group id and group external reference for the find tenant operation. Please only provide one of the two."
  }
}

Status Code - 404 Returned if no tenant records could not be found.

No tenant records found for the provided parameters

{
   "error": {
    "type": "not_found",
    "message": "There are no tenant records matching the provided parameters."
  }
}

curl --location --request POST 'https://api.travtus.com/leases/tenants/' \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
    "min_move_in_date": "2020-01-17",
    "identifier": "lease-1"
}'

{
  "tenants": [
    {
      "identifier": "internal-id-1",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant",
      "external_ref": "id-1",
      "phone_number": "01234567890"
    },
    {
      "identifier": "internal-id-2",
      "email_address": "[email protected]",
      "first_name": "Test",
      "last_name": "Tenant 2",
      "external_ref": "id-2",
      "phone_number": "01234567890"
    }
  ],
  "last_id": 5
}

⌘I

Introduction

Webhook

Endpoints

Example use cases

Header

Body

Response

Errors

​Example use cases

​Header

​Body

​Response

​Errors

Example use cases

Header

Body

Response

Errors