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

List Task Templates

Tasks · REST API reference

Get support
GET/v1/facilities/{facility_id}/task-templates
A facility's recurring templates, or with `all` every facility's, and the kinds a template can be created with now.

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>/task-templates' \
  --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 · string | stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "available_kinds": [
      "inspection"
    ],
    "templates": [
      {
        "anchor_on": "2026-10-29",
        "assignee": {
          "display_name": "string",
          "id": "00000000-0000-4000-8000-000000000001"
        },
        "assignee_id": "00000000-0000-4000-8000-000000000001",
        "assignment_mode": "string",
        "cadence": "string",
        "capabilities": {
          "delete": false,
          "edit": false,
          "pause": false
        },
        "created_at": "2026-10-29T12:00:00Z",
        "created_by": "00000000-0000-4000-8000-000000000001",
        "day_of_month": 0,
        "description": "string",
        "due_offset_days": 0,
        "estimated_cost": "<VALUE_MATCHING_PATTERN>",
        "facility_id": "00000000-0000-4000-8000-000000000001",
        "facility_name": "string",
        "id": "00000000-0000-4000-8000-000000000001",
        "inspection_kind": "string",
        "interval_count": 0,
        "is_active": false,
        "kind": "string",
        "last_run_on": "2026-10-29",
        "next_run_on": "2026-10-29",
        "priority": "string",
        "requires_photo_proof": false,
        "skip_if_open": false,
        "task_type": "string",
        "title": "string",
        "unit_group_id": "00000000-0000-4000-8000-000000000001",
        "updated_at": "2026-10-29T12:00:00Z",
        "vendor": "string",
        "weekday": 0,
        "work_order_category": "string"
      }
    ]
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataTaskTemplateListResponserequired

The templates of a facility, or of every facility, and the kinds a template can be created with now.

Show data schema
available_kindsstring[]required

The kinds a template can be created with now, in alphabetical order.

Show available_kinds schema
string

Values: "inspection", "task", "work_order"

templatesTaskTemplateResponse[]required

Every template of the scope, paused ones included, ordered by next scheduled day, then title.

Show templates schema
anchor_onstringrequired

The date the schedule counts from, in the facility's calendar.

Format: date

assigneePersonResponse | nullrequired

That person; null when there is none.

Show assignee schema
PersonResponse | null

That person; null when there is none.

Variant 1: PersonResponse
display_namestringrequired

The name to show for the user.

idstringrequired

The user's id.

Format: uuid

Variant 2: null
null
assignee_idstring | nullrequired

The person a direct template gives each task to; null otherwise.

Format: uuid

Show assignee_id schema
string | null

The person a direct template gives each task to; null otherwise.

Variant 1: string
string
Variant 2: null
null
assignment_modestringrequired

direct, auto or unassigned: who gets each task filed.

cadencestringrequired

daily, weekly or monthly.

capabilitiesTaskTemplateCapabilitiesResponserequired

What the caller may do with a template now, from their permissions at its facility.

Show capabilities schema
deletebooleanrequired

True when the caller may delete it now.

editbooleanrequired

True when the caller may change the template now.

pausebooleanrequired

True when the caller may pause or resume it now.

created_atstringrequired

When the template was created.

Format: date-time

created_bystringrequired

Who created it.

Format: uuid

day_of_monthinteger | nullrequired

A monthly template's day of the month, 1 to 31; null otherwise.

Show day_of_month schema
integer | null

A monthly template's day of the month, 1 to 31; null otherwise.

Variant 1: integer
integer
Variant 2: null
null
descriptionstring | nullrequired

Longer detail copied onto each task filed.

Show description schema
string | null

Longer detail copied onto each task filed.

Variant 1: string
string
Variant 2: null
null
due_offset_daysintegerrequired

How many days after its scheduled day each task falls due.

estimated_coststring | nullrequired

A work order template's estimate, as a decimal string; null when there is none.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show estimated_cost schema
string | null

A work order template's estimate, as a decimal string; null when there is none.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility the template files at.

Format: uuid

facility_namestringrequired

That facility's name.

idstringrequired

The template's id.

Format: uuid

inspection_kindstring | nullrequired

An inspection template's kind of round; null otherwise.

Show inspection_kind schema
string | null

An inspection template's kind of round; null otherwise.

Variant 1: string
string
Variant 2: null
null
interval_countintegerrequired

Every how many days, weeks or months.

is_activebooleanrequired

False while the template is paused.

kindstringrequired

What each run files: task, work_order or inspection.

last_run_onstring | nullrequired

The last scheduled day a run handled; null before the first.

Format: date

Show last_run_on schema
string | null

The last scheduled day a run handled; null before the first.

Variant 1: string
string
Variant 2: null
null
next_run_onstringrequired

The next scheduled day, in the facility's calendar.

Format: date

prioritystringrequired

How urgent each task filed is.

requires_photo_proofboolean | nullrequired

Whether each task filed needs proof photos. Null: each takes the facility's default for its type on the day it is filed.

Show requires_photo_proof schema
boolean | null

Whether each task filed needs proof photos. Null: each takes the facility's default for its type on the day it is filed.

Variant 1: boolean
boolean
Variant 2: null
null
skip_if_openbooleanrequired

True skips a scheduled day while a task this template filed is still open.

task_typestringrequired

The board type of each task filed. A work order or inspection template's is its kind.

titlestringrequired

What each task filed is called.

unit_group_idstring | nullrequired

The unit group an inspection template's rounds cover; null for the whole facility or another kind.

Format: uuid

Show unit_group_id schema
string | null

The unit group an inspection template's rounds cover; null for the whole facility or another kind.

Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

When it last changed.

Format: date-time

vendorstring | nullrequired

A work order template's vendor; null when there is none.

Show vendor schema
string | null

A work order template's vendor; null when there is none.

Variant 1: string
string
Variant 2: null
null
weekdayinteger | nullrequired

A weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.

Show weekday schema
integer | null

A weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.

Variant 1: integer
integer
Variant 2: null
null
work_order_categorystring | nullrequired

A work order template's trade category; null otherwise.

Show work_order_category schema
string | null

A work order template's trade category; null otherwise.

Variant 1: string
string
Variant 2: null
null
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

List Task Templates | Facily Developers