Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Facility Config
Search the full API reference Esc to close

Get Facility Config

Organization · REST API reference

Get support
GET/v1/facilities/{facility_id}/config

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/config' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

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

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · stringrequired

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "access_control": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "billing": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "delinquency": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "localization": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "notifications": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "operations": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    },
    "payments": {
      "inherited": {},
      "inherited_from": {},
      "overrides": {},
      "resolved": {}
    }
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataConfigResponserequired

GET/PATCH .../config response body: all seven domains, each with provenance. Field names match ``core.models.config.CONFIG_SCHEMAS`` keys.

Show data schema
access_controlConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show access_control schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
billingConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show billing schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
delinquencyConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show delinquency schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
localizationConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show localization schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
notificationsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show notifications schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
operationsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show operations schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
paymentsConfigDomainResponserequired

One config domain's GET/PATCH response: effective value + provenance.

Show payments schema
inheritedobjectrequired
inherited_fromobjectrequired
overridesobjectrequired
resolvedobjectrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Build something that works beautifully.

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

Get Facility Config | Facily Developers