/v1/tenants/{tenant_id}/contactsAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --request GET \
--url 'https://api.staging.facily.ai/v1/tenants/<TENANT_ID>/contacts' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
tenant_idpath · stringrequiredFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
sortquery · string | nullValues: "created_at", "contact_type"
orderquery · stringDefault: "desc" · Values: "asc", "desc"
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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[]requiredShow data schema
addressAddressResponse | nullThe contact's mailing address. Returned by the contact writes; the list leaves it out.
Show address schema
AddressResponse | nullThe contact's mailing address. Returned by the contact writes; the list leaves it out.
Variant 1: AddressResponse
address_typestringrequiredWhat the address is used for, for example physical, billing, or mailing.
citystringrequiredCity or town.
countrystringISO 3166-1 alpha-2 country code.
Default: "US"
idstringrequiredUnique identifier for this address.
Format: uuid
is_primarybooleanrequiredTrue for the address used by default when only one is needed.
latitudestring | nullLatitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show latitude schema
string | nullLatitude in decimal degrees, where the address has been geocoded.
Variant 1: string
Variant 2: null
longitudestring | nullLongitude in decimal degrees, where the address has been geocoded.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show longitude schema
string | nullLongitude in decimal degrees, where the address has been geocoded.
Variant 1: string
Variant 2: null
statestringrequiredState, province, or region.
streetstringrequiredFirst line of the street address.
street_2string | nullSecond line, for a unit, suite, or apartment number.
Show street_2 schema
string | nullSecond line, for a unit, suite, or apartment number.
Variant 1: string
Variant 2: null
verification_statusstring | nullOutcome of address validation, for example verified, unverified, or corrected.
Show verification_status schema
string | nullOutcome of address validation, for example verified, unverified, or corrected.
Variant 1: string
Variant 2: null
verified_atstring | nullWhen the address was last validated against a postal database.
Format: date-time
Show verified_at schema
string | nullWhen the address was last validated against a postal database.
Variant 1: string
Variant 2: null
zipstringrequiredPostal or ZIP code.
Variant 2: null
nullcontact_typestringrequiredcreated_atstringrequiredFormat: date-time
emailstring | nullShow email schema
string | nullVariant 1: string
stringVariant 2: null
nullfirst_namestringrequiredidstringrequiredFormat: uuid
is_gate_access_authorizedbooleanrequiredlast_namestringrequiredphonestring | nullShow phone schema
string | nullVariant 1: string
stringVariant 2: null
nullrelationshipstring | nullShow relationship schema
string | nullVariant 1: string
stringVariant 2: null
nullupdated_atstringrequiredFormat: date-time
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired