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

Get Task Settings

Tasks · REST API reference

Get support
GET/v1/facilities/{facility_id}/tasks/settings
The task settings a reader of one facility's tasks needs: today's date at the facility, the photo proof settings and when an overdue task escalates.

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>/tasks/settings' \
  --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": {
    "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

dataTaskSettingsResponserequired

The task settings of one facility, as a reader of its tasks needs them.

Show data schema
escalationTaskEscalationSettingsResponserequired

When an overdue task escalates.

Show escalation schema
days_overdueintegerrequired

Days past the due date after which a task escalates.

enabledbooleanrequired

Whether overdue tasks escalate.

facility_todaystringrequired

Today's date at the facility.

Format: date

proofTaskProofSettingsResponserequired

Photo proof settings.

Show proof schema
by_typeTaskProofTypesResponserequired

Whether a new task of each type asks for proof photos. One field per type a create can name.

Show by_type schema
auction_prepbooleanrequired

A new task of this type asks for proof photos.

clean_unitbooleanrequired

A new task of this type asks for proof photos.

collectionbooleanrequired

A new task of this type asks for proof photos.

follow_upbooleanrequired

A new task of this type asks for proof photos.

inspectionbooleanrequired

A new task of this type asks for proof photos.

lock_checkbooleanrequired

A new task of this type asks for proof photos.

maintenancebooleanrequired

A new task of this type asks for proof photos.

otherbooleanrequired

A new task of this type asks for proof photos.

overlockbooleanrequired

A new task of this type asks for proof photos.

remove_overlockbooleanrequired

A new task of this type asks for proof photos.

reviewbooleanrequired

A new task of this type asks for proof photos.

unit_prepbooleanrequired

A new task of this type asks for proof photos.

walkthroughbooleanrequired

A new task of this type asks for proof photos.

work_orderbooleanrequired

A new task of this type asks for proof photos.

max_per_typeintegerrequired

The most photos of one type a task may hold.

min_photosintegerrequired

How many proof photos complete a task.

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
Continue exploringAll tasks operations
Build something that works beautifully.

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

Get Task Settings | Facily Developers