Updated October 29, 2026
Make your first request
Read your facilities, inspect a response, and use a facility ID in your next request.
Send a read request
Set FACILY_API_KEY in your server environment. Your key must permit facility reads.
cURL
curl --request GET \
--url 'https://api.staging.facily.ai/v1/facilities?limit=10' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Accept: application/json'Inspect the result
Check the HTTP status before reading data. A successful list may be empty when no facilities are visible to your key. Use the exact schema in the Facilities reference for your client types.
JSON · condensed, synthetic example
{
"data": [
{
"id": "00000000-0000-4000-8000-000000000001",
"name": "Example facility"
}
],
"pagination": {
"cursor": null,
"has_more": false,
"total_count": 1
},
"meta": {
"request_id": "example-request-id"
}
}For 401, check the credential and environment. For 403, check the key’s permissions, facility scope, and source-IP restrictions.
Read units at a facility
Replace FACILITY_ID with an ID returned by the facilities request. Do not use the illustrative UUID from this guide as a real facility.
cURL
curl --request GET \
--url "https://api.staging.facily.ai/v1/facilities/$FACILITY_ID/units?limit=50" \
--header "Authorization: Bearer $FACILY_API_KEY"Keep buildingExplore the API reference