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

List Tenant Contacts

Tenants · REST API reference

Get support
GET/v1/tenants/{tenant_id}/contacts

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>/contacts' \
  --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

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

sortquery · string | null

Values: "created_at", "contact_type"

orderquery · string

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

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "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"
    }
  ],
  "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

dataTenantContactResponse[]required
Show data 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*$

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
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

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 Tenant Contacts | Facily Developers