Skip to content
FacilydevelopersDashboard
Build with Facily
Search the full API reference Esc to close

Get started with Facily REST APIs

Connect your software to the operations behind every facility. Work with facilities, units, tenants, leases, and more through one consistent API.

Get support
Facily’s APIs use REST, accept and return JSON, and use bearer credentials for authenticated requests. Start with a read request, understand the response, then build out your integration.

Before you start

You’ll need access to a Facily organization and an API key with the permissions your integration needs. Environment access is provisioned by Facily; staging is not a self-service sandbox.

Organization access Scoped API key Server-side application

1 Get your API key

Sign in to your organization and open Settings → Developer. With API-key administration permission, create a key for your integration.

  1. Name the integration so your team can recognize it.
  2. Choose the minimum permissions and facility scope it needs.
  3. Copy the key when it is created. The full secret is shown only once.
  4. Store it on your server as FACILY_API_KEY.

Keep secret keys out of frontend code, URLs, logs, and source control.

Understand authentication and permissions

2 Make your first request

Use your staging key to list the facilities you can access. Replace the origin only when you’re ready to use separately provisioned production access.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities?limit=10' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Accept: application/json'

Examples do not run in this page. Python uses the third-party requests package; JavaScript uses the native Fetch API.

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

GET requests only. Your key’s permissions and facility scope still apply.

Response
Your response will appear here.

3 Read the response

Successful responses wrap the resource in data. Lists also return pagination information. Keep meta.request_id when you need to trace a request with support.

JSON · illustrative response
{
  "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"
  }
}
Condensed example with synthetic values. See the endpoint reference for the complete response schema.

Use the facility id in a facility-scoped request, such as /v1/facilities/{facility_id}/units. A key can only see facilities and resources within its granted scope.

Make it your own

Move from your first request to a working integration.

Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get started with Facily REST APIs | Facily Developers