Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Tenant
Search the full API reference Esc to close

Get Tenant

Tenants · REST API reference

Get support
GET/v1/tenants/{tenant_id}

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/tenants/<TENANT_ID>' \
  --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

tenant_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "addresses": [
      {
        "address_type": "string",
        "city": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "is_primary": false,
        "state": "string",
        "street": "string",
        "zip": "string",
        "country": "US",
        "latitude": "<VALUE_MATCHING_PATTERN>",
        "longitude": "<VALUE_MATCHING_PATTERN>",
        "street_2": "string",
        "verification_status": "string"
      }
    ],
    "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"
    },
    "contacts": [
      {
        "contact_type": "string",
        "created_at": "2026-10-29T12:00:00Z",
        "first_name": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "is_gate_access_authorized": false,
        "last_name": "string",
        "updated_at": "2026-10-29T12:00:00Z",
        "address": {
          "address_type": "string",
          "city": "string",
          "id": "00000000-0000-4000-8000-000000000001",
          "is_primary": false,
          "state": "string",
          "street": "string",
          "zip": "string",
          "country": "US",
          "latitude": "<VALUE_MATCHING_PATTERN>",
          "longitude": "<VALUE_MATCHING_PATTERN>",
          "street_2": "string",
          "verification_status": "string"
        },
        "email": "string",
        "phone": "string",
        "relationship": "string"
      }
    ],
    "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"
        }
      }
    ],
    "payment_methods": [
      {
        "added_via": "string",
        "created_at": "2026-10-29T12:00:00Z",
        "id": "00000000-0000-4000-8000-000000000001",
        "is_active": false,
        "is_chargeable": false,
        "is_default": false,
        "method_type": "string",
        "provider": "string",
        "updated_at": "2026-10-29T12:00:00Z",
        "ach_account_type": "string",
        "ach_bank_name": "string",
        "bank_holder_type": "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"
  }
}

application/json

dataTenantDetailResponserequired

Full tenant detail. Includes PII fields visible only on the detail endpoint.

Show data schema
access_contactsTenantAccessContactResponse[]

How this tenant's name and phone reach each access-control provider; empty until a provider has linked them.

Show access_contacts schema
holder_hiddenboolean

True when another tenant record holds the account but the caller cannot read tenants at its facility, so it is not named; false when none holds it yet.

Default: false

holder_namestring | null

That record's name, under the same rule.

Show holder_name schema
string | null

That record's name, under the same rule.

Variant 1: string
string
Variant 2: null
null
holder_tenant_idstring | null

When the name and phone sent are another tenant record's, that record; null when none is found or the caller cannot read tenants at its facility.

Format: uuid

Show holder_tenant_id schema
string | null

When the name and phone sent are another tenant record's, that record; null when none is found or the caller cannot read tenants at its facility.

Variant 1: string
string
Variant 2: null
null
link_statusstringrequired

The tenant's account link with the provider: new, linked or needs_review.

owns_contactbooleanrequired

True when this tenant record holds the provider account's name and phone; it stays true while the link is under review.

providerstringrequired

The access-control provider, for example kiss.

sends_contactbooleanrequired

True when an edit to this tenant's name or phone is sent to the provider, where the phone is how the tenant signs in to open their unit.

sync_activebooleanrequired

True while Facily is sending this facility's access to the provider.

sync_pausedbooleanrequired

True while that sending is paused: an edit is sent when it resumes.

addressesAddressResponse[]required
Show addresses schema
address_typestringrequired

What the address is used for, for example physical, billing, or mailing.

citystringrequired

City or town.

countrystring

ISO 3166-1 alpha-2 country code.

Default: "US"

idstringrequired

Unique identifier for this address.

Format: uuid

is_primarybooleanrequired

True for the address used by default when only one is needed.

latitudestring | null

Latitude in decimal degrees, where the address has been geocoded.

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

Show latitude schema
string | null

Latitude in decimal degrees, where the address has been geocoded.

Variant 1: string
string
Variant 2: null
null
longitudestring | null

Longitude in decimal degrees, where the address has been geocoded.

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

Show longitude schema
string | null

Longitude in decimal degrees, where the address has been geocoded.

Variant 1: string
string
Variant 2: null
null
statestringrequired

State, province, or region.

streetstringrequired

First line of the street address.

street_2string | null

Second line, for a unit, suite, or apartment number.

Show street_2 schema
string | null

Second line, for a unit, suite, or apartment number.

Variant 1: string
string
Variant 2: null
null
verification_statusstring | null

Outcome of address validation, for example verified, unverified, or corrected.

Show verification_status schema
string | null

Outcome of address validation, for example verified, unverified, or corrected.

Variant 1: string
string
Variant 2: null
null
verified_atstring | null

When the address was last validated against a postal database.

Format: date-time

Show verified_at schema
string | null

When the address was last validated against a postal database.

Variant 1: string
string
Variant 2: null
null
zipstringrequired

Postal or ZIP code.

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
contactsTenantContactResponse[]required
Show contacts schema
addressAddressResponse | null

The contact's mailing address. Returned by the contact writes; the list leaves it out.

Show address schema
AddressResponse | null

The contact's mailing address. Returned by the contact writes; the list leaves it out.

Variant 1: AddressResponse
address_typestringrequired

What the address is used for, for example physical, billing, or mailing.

citystringrequired

City or town.

countrystring

ISO 3166-1 alpha-2 country code.

Default: "US"

idstringrequired

Unique identifier for this address.

Format: uuid

is_primarybooleanrequired

True for the address used by default when only one is needed.

latitudestring | null

Latitude in decimal degrees, where the address has been geocoded.

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

longitudestring | null

Longitude in decimal degrees, where the address has been geocoded.

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

statestringrequired

State, province, or region.

streetstringrequired

First line of the street address.

street_2string | null

Second line, for a unit, suite, or apartment number.

verification_statusstring | null

Outcome of address validation, for example verified, unverified, or corrected.

verified_atstring | null

When the address was last validated against a postal database.

Format: date-time

zipstringrequired

Postal or ZIP code.

Variant 2: null
null
contact_typestringrequired
created_atstringrequired

Format: date-time

emailstring | null
Show email schema
string | null
Variant 1: string
string
Variant 2: null
null
first_namestringrequired
idstringrequired

Format: uuid

is_gate_access_authorizedbooleanrequired
last_namestringrequired
phonestring | null
Show phone schema
string | null
Variant 1: string
string
Variant 2: null
null
relationshipstring | null
Show relationship schema
string | null
Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

Format: date-time

created_atstringrequired

When the tenant record was created.

Format: date-time

date_of_birthstring | null

Format: date

Show date_of_birth schema
string | null
Variant 1: string
string
Variant 2: null
null
delinquency_exemptbooleanrequired

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

delinquency_summaryTenantDelinquencySummary | null
Show delinquency_summary schema
TenantDelinquencySummary | null
Variant 1: TenantDelinquencySummary
delinquent_lease_countintegerrequired
max_days_past_dueintegerrequired
total_past_duestringrequired

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

worst_stagestringrequired
Variant 2: null
null
do_not_rent_atstring | null

When staff first flagged this person as do not rent; null when not flagged.

Format: date-time

Show do_not_rent_at schema
string | null

When staff first flagged this person as do not rent; null when not flagged.

Variant 1: string
string
Variant 2: null
null
do_not_rent_bystring | null

The staff user who first flagged this person.

Format: uuid

Show do_not_rent_by schema
string | null

The staff user who first flagged this person.

Variant 1: string
string
Variant 2: null
null
do_not_rent_notestring | null

The staff note that goes with the flag.

Show do_not_rent_note schema
string | null

The staff note that goes with the flag.

Variant 1: string
string
Variant 2: null
null
do_not_rent_reasonstring | null

Why staff should not rent to this person: delinquency, fraud, damage, conduct or other.

Values: "delinquency", "fraud", "damage", "conduct", "other"

Show do_not_rent_reason schema
string | null

Why staff should not rent to this person: delinquency, fraud, damage, conduct or other.

Variant 1: string
string

Values: "delinquency", "fraud", "damage", "conduct", "other"

Variant 2: null
null
drivers_license_numberstring | null
Show drivers_license_number schema
string | null
Variant 1: string
string
Variant 2: null
null
drivers_license_statestring | null
Show drivers_license_state schema
string | null
Variant 1: string
string
Variant 2: null
null
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
notesstring | null
Show notes schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_methodsPaymentMethodResponse[]required
Show payment_methods schema
ach_account_typestring | null

Whether the ACH account is checking or savings.

Show ach_account_type schema
string | null

Whether the ACH account is checking or savings.

Variant 1: string
string
Variant 2: null
null
ach_bank_namestring | null

Name of the bank holding the account, for an ACH method.

Show ach_bank_name schema
string | null

Name of the bank holding the account, for an ACH method.

Variant 1: string
string
Variant 2: null
null
added_viastringrequired

How the method was stored, for example by the tenant in the portal or by staff.

bank_holder_typestring | null

Whether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.

Show bank_holder_type schema
string | null

Whether the bank account belongs to a person or a business, as the processor classifies it. Null for a card, and for a bank account stored before Facily recorded it.

Variant 1: string
string
Variant 2: null
null
bin_typestring | null

CREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.

Show bin_type schema
string | null

CREDIT, DEBIT, or PREPAID as the processor reports it. Drives surcharging.

Variant 1: string
string
Variant 2: null
null
card_brandstring | null

Card network, for example Visa or Mastercard.

Show card_brand schema
string | null

Card network, for example Visa or Mastercard.

Variant 1: string
string
Variant 2: null
null
card_exp_monthinteger | null

Card expiry month, 1 to 12.

Show card_exp_month schema
integer | null

Card expiry month, 1 to 12.

Variant 1: integer
integer
Variant 2: null
null
card_exp_yearinteger | null

Card expiry year, four digits.

Show card_exp_year schema
integer | null

Card expiry year, four digits.

Variant 1: integer
integer
Variant 2: null
null
created_atstringrequired

When the method was stored.

Format: date-time

idstringrequired

Unique identifier for this stored payment method.

Format: uuid

is_activebooleanrequired

Whether the method may currently be charged.

is_chargeablebooleanrequired

True when this method can actually be charged: a live, non-deleted token at the current processor. A migrated legacy row is false.

is_defaultbooleanrequired

True for the method charged when no other is specified.

last_fourstring | null

Last four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.

Show last_four schema
string | null

Last four digits of the card or bank account, for identifying it to the tenant. No other digits are ever stored or returned.

Variant 1: string
string
Variant 2: null
null
method_typestringrequired

The instrument type, for example card or ACH.

nicknamestring | null

Staff-set label, for telling two cards on file apart.

Show nickname schema
string | null

Staff-set label, for telling two cards on file apart.

Variant 1: string
string
Variant 2: null
null
providerstringrequired

Who holds the token: stax for a chargeable method, legacy for a method migrated from the previous system whose token has not yet been imported.

updated_atstringrequired

When the method was last modified.

Format: date-time

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.

primary_addressAddressResponse | null
Show primary_address schema
AddressResponse | null
Variant 1: AddressResponse
address_typestringrequired

What the address is used for, for example physical, billing, or mailing.

citystringrequired

City or town.

countrystring

ISO 3166-1 alpha-2 country code.

Default: "US"

idstringrequired

Unique identifier for this address.

Format: uuid

is_primarybooleanrequired

True for the address used by default when only one is needed.

latitudestring | null

Latitude in decimal degrees, where the address has been geocoded.

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

Show latitude schema
string | null

Latitude in decimal degrees, where the address has been geocoded.

Variant 1: string
Variant 2: null
longitudestring | null

Longitude in decimal degrees, where the address has been geocoded.

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

Show longitude schema
string | null

Longitude in decimal degrees, where the address has been geocoded.

Variant 1: string
Variant 2: null
statestringrequired

State, province, or region.

streetstringrequired

First line of the street address.

street_2string | null

Second line, for a unit, suite, or apartment number.

Show street_2 schema
string | null

Second line, for a unit, suite, or apartment number.

Variant 1: string
Variant 2: null
verification_statusstring | null

Outcome of address validation, for example verified, unverified, or corrected.

Show verification_status schema
string | null

Outcome of address validation, for example verified, unverified, or corrected.

Variant 1: string
Variant 2: null
verified_atstring | null

When the address was last validated against a postal database.

Format: date-time

Show verified_at schema
string | null

When the address was last validated against a postal database.

Variant 1: string
Variant 2: null
zipstringrequired

Postal or ZIP code.

Variant 2: null
null
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
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

Get Tenant | Facily Developers