/v1/partner/facilitiesAuthentication
Channel-scoped partner key.
A standard staff key is not interchangeable with a partner key. Call this endpoint from your server.
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/partner/facilities' \
--header "Authorization: Bearer $FACILY_PARTNER_KEY"Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"access_hours": {
"all_day": false,
"friday": {
"close": "string",
"open": "string"
},
"monday": {
"close": "string",
"open": "string"
},
"saturday": {
"close": "string",
"open": "string"
},
"sunday": {
"close": "string",
"open": "string"
},
"thursday": {
"close": "string",
"open": "string"
},
"tuesday": {
"close": "string",
"open": "string"
},
"wednesday": {
"close": "string",
"open": "string"
}
},
"code": "string",
"email": "string",
"id": "00000000-0000-4000-8000-000000000001",
"live": false,
"name": "string",
"office_hours": {
"all_day": false,
"friday": {
"close": "string",
"open": "string"
},
"monday": {
"close": "string",
"open": "string"
},
"saturday": {
"close": "string",
"open": "string"
},
"sunday": {
"close": "string",
"open": "string"
},
"thursday": {
"close": "string",
"open": "string"
},
"tuesday": {
"close": "string",
"open": "string"
},
"wednesday": {
"close": "string",
"open": "string"
}
},
"phone": "string",
"postal_address": "string",
"reservation_hold_days": 0,
"reservations_enabled": false,
"timezone": "string",
"wait_list_enabled": false,
"website_url": "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
dataPartnerFacilityResponse[]requiredShow data schema
access_hoursWeeklyHours | nullrequiredShow access_hours schema
WeeklyHours | nullVariant 1: WeeklyHours
all_daybooleanDefault: false
fridayDayHours | nullShow friday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
mondayDayHours | nullShow monday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
saturdayDayHours | nullShow saturday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
sundayDayHours | nullShow sunday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
thursdayDayHours | nullShow thursday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
tuesdayDayHours | nullShow tuesday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
wednesdayDayHours | nullShow wednesday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
Variant 2: null
nullcodestringrequiredThe facility's short code.
emailstring | nullrequiredShow email schema
string | nullVariant 1: string
stringVariant 2: null
nullidstringrequiredFormat: uuid
livebooleanrequiredWhether the facility runs on Facily. Writes are refused in production until it is.
namestringrequiredoffice_hoursWeeklyHours | nullrequiredShow office_hours schema
WeeklyHours | nullVariant 1: WeeklyHours
all_daybooleanDefault: false
fridayDayHours | nullShow friday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
mondayDayHours | nullShow monday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
saturdayDayHours | nullShow saturday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
sundayDayHours | nullShow sunday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
thursdayDayHours | nullShow thursday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
tuesdayDayHours | nullShow tuesday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
wednesdayDayHours | nullShow wednesday schema
DayHours | nullVariant 1: DayHours
Variant 2: null
Variant 2: null
nullphonestring | nullrequiredShow phone schema
string | nullVariant 1: string
stringVariant 2: null
nullpostal_addressstring | nullrequiredThe facility's postal address, one line per row.
Show postal_address schema
string | nullThe facility's postal address, one line per row.
Variant 1: string
stringVariant 2: null
nullreservation_hold_daysinteger | nullrequiredDays a reservation holds its unit; null means no limit.
Show reservation_hold_days schema
integer | nullDays a reservation holds its unit; null means no limit.
Variant 1: integer
integerVariant 2: null
nullreservations_enabledbooleanrequiredtimezonestringrequiredIANA time zone the hours are in.
wait_list_enabledbooleanrequiredwebsite_urlstring | nullrequiredShow website_url schema
string | nullVariant 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