/v1/facilitiesAuthentication
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/facilities' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
sortquery · string | nullValues: "name", "created_at"
orderquery · stringDefault: "asc" · Values: "asc", "desc"
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"code": "string",
"created_at": "2026-10-29T12:00:00Z",
"id": "00000000-0000-4000-8000-000000000001",
"is_active": false,
"is_live": false,
"measurement_system": "string",
"name": "string",
"timezone": "string",
"unit_summary": {
"available": 0,
"maintenance": 0,
"occupancy_rate": "<VALUE_MATCHING_PATTERN>",
"occupied": 0,
"overlocked": 0,
"reserved": 0,
"total": 0,
"computed_at": "2026-10-29T12:00:00Z",
"is_stale": false
},
"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"
},
"billing_go_live_on": "2026-10-29"
}
],
"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
dataFacilityResponse[]requiredShow data schema
addressAddressResponse | nullStreet address of the site.
Show address schema
AddressResponse | nullStreet address of the site.
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
nullbilling_go_live_onstring | nullThe go-live date of the facility's billing cutover, or null when none is recorded. Move-ins, move-outs and transfers are refused before it.
Format: date
Show billing_go_live_on schema
string | nullThe go-live date of the facility's billing cutover, or null when none is recorded. Move-ins, move-outs and transfers are refused before it.
Variant 1: string
stringVariant 2: null
nullcodestringrequiredShort operator-assigned code identifying the facility, unique within the organization.
created_atstringrequiredWhen the facility record was created.
Format: date-time
emailstring | nullPublic contact email address.
Show email schema
string | nullPublic contact email address.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this facility.
Format: uuid
inbound_email_addressstring | nullThe facility's own email address on the platform: mail sent to it, and replies to the facility's email, arrive in its Received messages. Read-only. Null when receiving email is off, and on the facility list.
Show inbound_email_address schema
string | nullThe facility's own email address on the platform: mail sent to it, and replies to the facility's email, arrive in its Received messages. Read-only. Null when receiving email is off, and on the facility list.
Variant 1: string
stringVariant 2: null
nullis_activebooleanrequiredFalse for a facility that has been closed or has not yet opened. Inactive facilities are excluded from operational processing.
is_livebooleanrequiredTrue once billing has been cut over and the facility's local date has reached its go-live date. Move-in, move-out and transfer are locked until then.
measurement_systemstringrequiredWhether unit dimensions are expressed as imperial or metric.
namestringrequiredThe facility's public name.
phonestring | nullPublic contact telephone number.
Show phone schema
string | nullPublic contact telephone number.
Variant 1: string
stringVariant 2: null
nullsms_numberstring | nullThe number the facility's texts are sent from and received at, in E.164. Read-only. Null when none is assigned, and on the facility list.
Show sms_number schema
string | nullThe number the facility's texts are sent from and received at, in E.164. Read-only. Null when none is assigned, and on the facility list.
Variant 1: string
stringVariant 2: null
nulltimezonestringrequiredIANA timezone identifier, for example 'America/New_York'. Billing runs, late fees and business dates all resolve against this rather than UTC.
unit_summaryUnitSummaryResponserequiredSmall denormalized aggregate inlined on FacilityResponse.
Show unit_summary schema
availableintegerrequiredcomputed_atstring | nullFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanDefault: false
maintenanceintegerrequiredoccupancy_ratestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
occupiedintegerrequiredoverlockedintegerrequiredreservedintegerrequiredtotalintegerrequiredupdated_atstringrequiredWhen the facility record was last modified.
Format: date-time
website_urlstring | nullThe facility's public website.
Show website_url schema
string | nullThe facility's public website.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope 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