/v1/facilities/{facility_id}/tasks/settingsAuthentication
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>/tasks/settings' \
--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": {
"escalation": {
"days_overdue": 0,
"enabled": false
},
"facility_today": "2026-10-29",
"proof": {
"by_type": {
"auction_prep": false,
"clean_unit": false,
"collection": false,
"follow_up": false,
"inspection": false,
"lock_check": false,
"maintenance": false,
"other": false,
"overlock": false,
"remove_overlock": false,
"review": false,
"unit_prep": false,
"walkthrough": false,
"work_order": false
},
"max_per_type": 0,
"min_photos": 0
}
},
"meta": {
"request_id": "string"
}
}application/json
dataTaskSettingsResponserequiredThe task settings of one facility, as a reader of its tasks needs them.
Show data schema
escalationTaskEscalationSettingsResponserequiredWhen an overdue task escalates.
Show escalation schema
days_overdueintegerrequiredDays past the due date after which a task escalates.
enabledbooleanrequiredWhether overdue tasks escalate.
facility_todaystringrequiredToday's date at the facility.
Format: date
proofTaskProofSettingsResponserequiredPhoto proof settings.
Show proof schema
by_typeTaskProofTypesResponserequiredWhether a new task of each type asks for proof photos. One field per type a create can name.
Show by_type schema
auction_prepbooleanrequiredA new task of this type asks for proof photos.
clean_unitbooleanrequiredA new task of this type asks for proof photos.
collectionbooleanrequiredA new task of this type asks for proof photos.
follow_upbooleanrequiredA new task of this type asks for proof photos.
inspectionbooleanrequiredA new task of this type asks for proof photos.
lock_checkbooleanrequiredA new task of this type asks for proof photos.
maintenancebooleanrequiredA new task of this type asks for proof photos.
otherbooleanrequiredA new task of this type asks for proof photos.
overlockbooleanrequiredA new task of this type asks for proof photos.
remove_overlockbooleanrequiredA new task of this type asks for proof photos.
reviewbooleanrequiredA new task of this type asks for proof photos.
unit_prepbooleanrequiredA new task of this type asks for proof photos.
walkthroughbooleanrequiredA new task of this type asks for proof photos.
work_orderbooleanrequiredA new task of this type asks for proof photos.
max_per_typeintegerrequiredThe most photos of one type a task may hold.
min_photosintegerrequiredHow many proof photos complete a task.
metaMetarequiredEnvelope 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