/v1/facilities/{facility_id}/configAuthentication
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/<FACILITY_ID>/config' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataConfigResponserequiredGET/PATCH .../config response body: all seven domains, each with provenance. Field names match ``core.models.config.CONFIG_SCHEMAS`` keys.
Show data schema
access_controlConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show access_control schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequiredbillingConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show billing schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequireddelinquencyConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show delinquency schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequiredlocalizationConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show localization schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequirednotificationsConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show notifications schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequiredoperationsConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show operations schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequiredpaymentsConfigDomainResponserequiredOne config domain's GET/PATCH response: effective value + provenance.
Show payments schema
inheritedobjectrequiredinherited_fromobjectrequiredoverridesobjectrequiredresolvedobjectrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation 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