Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Tenants
Search the full API reference Esc to close

List Tenants

Tenants · REST API reference

Get support
GET/v1/facilities/{facility_id}/tenants

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/tenants' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

pagequery · integer | null

1-based page number, for a numbered pager. Mutually exclusive with `cursor`.

Minimum: 1

sortquery · string | null

Values: "last_name", "created_at", "total_balance", "tenant_number"

orderquery · string

Default: "asc" · Values: "asc", "desc"

searchquery · string | null
statusquery · string[] | null
has_balancequery · boolean | null
is_businessquery · boolean | null
metricsquery · boolean

Embed the cached KPI metrics block in the response.

Default: false

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": [
    {
      "communication_preferences": {
        "email_suppressed": false,
        "invoice_delivery": "string",
        "marketing_sms_opt_in_evidence_id": "00000000-0000-4000-8000-000000000001",
        "marketing_sms_opt_in_recorded_by": "00000000-0000-4000-8000-000000000001",
        "marketing_sms_opt_in_source": "string",
        "marketing_sms_opted_in_at": "2026-10-29T12:00:00Z",
        "marketing_sms_revoked_at": "2026-10-29T12:00:00Z",
        "preferred_channels": [
          "string"
        ],
        "sms_opt_in_evidence_id": "00000000-0000-4000-8000-000000000001",
        "sms_opt_in_recorded_by": "00000000-0000-4000-8000-000000000001",
        "sms_opt_in_source": "storedge_import",
        "sms_opted_in_at": "2026-10-29T12:00:00Z"
      },
      "created_at": "2026-10-29T12:00:00Z",
      "delinquency_exempt": false,
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "first_name": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "is_business": false,
      "last_name": "string",
      "leases": [
        {
          "id": "00000000-0000-4000-8000-000000000001",
          "lease_number": "string",
          "next_billing_date": "2026-10-29",
          "rate": "<VALUE_MATCHING_PATTERN>",
          "start_date": "2026-10-29",
          "status": "string",
          "tenant_id": "00000000-0000-4000-8000-000000000001",
          "tenant_name": "string",
          "unit_number": "string",
          "insurance_plan": {
            "coverage_amount": "<VALUE_MATCHING_PATTERN>",
            "id": "00000000-0000-4000-8000-000000000001",
            "monthly_premium": "<VALUE_MATCHING_PATTERN>",
            "name": "string"
          }
        }
      ],
      "portal_enabled": false,
      "status": "string",
      "system_tags": [
        "string"
      ],
      "tags": [
        {
          "facility_id": "00000000-0000-4000-8000-000000000001",
          "id": "00000000-0000-4000-8000-000000000001",
          "name": "string",
          "color": "string"
        }
      ],
      "tax_exempt": false,
      "tenant_number": "string",
      "total_balance": "<VALUE_MATCHING_PATTERN>",
      "updated_at": "2026-10-29T12:00:00Z"
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataTenantResponse[]required
Show data schema
communication_preferencesTenantCommunicationPreferencesrequired

How one tenant has agreed to be contacted (design 6.4).

Show communication_preferences schema
email_suppressedboolean

Default: false

invoice_deliverystring | null
Show invoice_delivery schema
string | null
Variant 1: string
string
Variant 2: null
null
marketing_sms_opt_in_evidence_idstring | null

Format: uuid

Show marketing_sms_opt_in_evidence_id schema
string | null
Variant 1: string
string
Variant 2: null
null
marketing_sms_opt_in_recorded_bystring | null

Format: uuid

Show marketing_sms_opt_in_recorded_by schema
string | null
Variant 1: string
string
Variant 2: null
null
marketing_sms_opt_in_sourcestring | null
Show marketing_sms_opt_in_source schema
string | null
Variant 1: string
string
Variant 2: null
null
marketing_sms_opted_in_atstring | null

Format: date-time

Show marketing_sms_opted_in_at schema
string | null
Variant 1: string
string
Variant 2: null
null
marketing_sms_revoked_atstring | null

Format: date-time

Show marketing_sms_revoked_at schema
string | null
Variant 1: string
string
Variant 2: null
null
preferred_channelsstring[]
Show preferred_channels schema
string
sms_opt_in_evidence_idstring | null

Format: uuid

Show sms_opt_in_evidence_id schema
string | null
Variant 1: string
string
Variant 2: null
null
sms_opt_in_recorded_bystring | null

Format: uuid

Show sms_opt_in_recorded_by schema
string | null
Variant 1: string
string
Variant 2: null
null
sms_opt_in_sourcestring | null

Values: "storedge_import", "staff_in_person", "staff_phone", "signed_document", "inbound_sms_start", "web_form", "partner"

Show sms_opt_in_source schema
string | null
Variant 1: string
string

Values: "storedge_import", "staff_in_person", "staff_phone", "signed_document", "inbound_sms_start", "web_form", "partner"

Variant 2: null
null
sms_opted_in_atstring | null

Format: date-time

Show sms_opted_in_at schema
string | null
Variant 1: string
string
Variant 2: null
null
sms_opted_outboolean

Default: false

company_namestring | null

Legal business name. Present only when is_business is true.

Show company_name schema
string | null

Legal business name. Present only when is_business is true.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the tenant record was created.

Format: date-time

delinquency_exemptbooleanrequired

True when staff have held this tenant out of the delinquency engine: no fees, no escalation, no notices.

emailstring | null

Primary email address, used for billing and notices.

Show email schema
string | null

Primary email address, used for billing and notices.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this tenant belongs to. A person renting at two sites is two tenant records.

Format: uuid

first_namestringrequired

Given name. For a business tenant this is the contact person.

idstringrequired

Unique identifier for this tenant.

Format: uuid

is_businessbooleanrequired

True when the tenant is an organization rather than an individual.

last_namestringrequired

Family name. For a business tenant this is the contact person.

leasesLeaseCompactResponse[]required

The tenant's leases, so a listing can show what they rent without a second call.

Show leases schema
idstringrequired

Unique identifier for the lease.

Format: uuid

insurance_planInsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Show insurance_plan schema
InsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Variant 1: InsurancePlanCompactResponse
coverage_amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

idstringrequired

Format: uuid

monthly_premiumstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

namestringrequired
Variant 2: null
null
lease_numberstringrequired

Operator-facing lease reference, unique within the facility.

next_billing_datestringrequired

Business date rent is next charged.

Format: date

ratestringrequired

Current monthly rent charged under this lease.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

start_datestringrequired

Business date the lease began.

Format: date

statusstringrequired

Lifecycle state of the lease.

tenant_idstringrequired

The tenant renting under this lease.

Format: uuid

tenant_namestringrequired

The tenant's display name, denormalized so a listing needs no second call.

unit_numberstringrequired

Label of the unit this lease occupies.

middle_initialstring | null

Middle initial, where recorded.

Show middle_initial schema
string | null

Middle initial, where recorded.

Variant 1: string
string
Variant 2: null
null
phonestring | null

Primary telephone number.

Show phone schema
string | null

Primary telephone number.

Variant 1: string
string
Variant 2: null
null
portal_enabledbooleanrequired

Whether the tenant can sign in to the self-service portal.

statusstringrequired

Lifecycle state of the tenant relationship, for example active, former, or lead.

system_tagsstring[]required

Labels the platform derives automatically, such as delinquency state. Not operator-editable.

Show system_tags schema
string
tagsTagResponse[]required

Operator-defined labels applied manually.

Show tags schema
colorstring | null

Colour used to render the tag, as a hex code.

Show color schema
string | null

Colour used to render the tag, as a hex code.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this tag is defined for.

Format: uuid

idstringrequired

Unique identifier for this tag.

Format: uuid

namestringrequired

Display label of the tag.

tax_exemptbooleanrequired

True when the tenant is exempt from sales tax on rent.

tax_exempt_idstring | null

The exemption certificate number substantiating tax_exempt.

Show tax_exempt_id schema
string | null

The exemption certificate number substantiating tax_exempt.

Variant 1: string
string
Variant 2: null
null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

total_balancestringrequired

Sum owed across all of this tenant's leases. Positive means money is owed; negative is a credit.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

updated_atstringrequired

When the tenant record was last modified.

Format: date-time

vehicle_descriptionstring | null

Description of a stored vehicle, where the facility rents parking.

Show vehicle_description schema
string | null

Description of a stored vehicle, where the facility rents parking.

Variant 1: string
string
Variant 2: null
null
vehicle_license_platestring | null

Registration plate of a stored vehicle.

Show vehicle_license_plate schema
string | null

Registration plate of a stored vehicle.

Variant 1: string
string
Variant 2: null
null
vehicle_license_statestring | null

Issuing state or province of the vehicle registration.

Show vehicle_license_state schema
string | null

Issuing state or province of the vehicle registration.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll tenants operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

List Tenants | Facily Developers