/v1/facilities/{facility_id}/task-templatesAuthentication
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>/task-templates' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataTaskTemplateListResponserequiredThe templates of a facility, or of every facility, and the kinds a template can be created with now.
Show data schema
available_kindsstring[]requiredThe kinds a template can be created with now, in alphabetical order.
Show available_kinds schema
stringValues: "inspection", "task", "work_order"
templatesTaskTemplateResponse[]requiredEvery template of the scope, paused ones included, ordered by next scheduled day, then title.
Show templates schema
anchor_onstringrequiredThe date the schedule counts from, in the facility's calendar.
Format: date
assigneePersonResponse | nullrequiredThat person; null when there is none.
Show assignee schema
PersonResponse | nullThat person; null when there is none.
Variant 1: PersonResponse
display_namestringrequiredThe name to show for the user.
idstringrequiredThe user's id.
Format: uuid
Variant 2: null
nullassignee_idstring | nullrequiredThe person a direct template gives each task to; null otherwise.
Format: uuid
Show assignee_id schema
string | nullThe person a direct template gives each task to; null otherwise.
Variant 1: string
stringVariant 2: null
nullassignment_modestringrequireddirect, auto or unassigned: who gets each task filed.
cadencestringrequireddaily, weekly or monthly.
capabilitiesTaskTemplateCapabilitiesResponserequiredWhat the caller may do with a template now, from their permissions at its facility.
Show capabilities schema
deletebooleanrequiredTrue when the caller may delete it now.
editbooleanrequiredTrue when the caller may change the template now.
pausebooleanrequiredTrue when the caller may pause or resume it now.
created_atstringrequiredWhen the template was created.
Format: date-time
created_bystringrequiredWho created it.
Format: uuid
day_of_monthinteger | nullrequiredA monthly template's day of the month, 1 to 31; null otherwise.
Show day_of_month schema
integer | nullA monthly template's day of the month, 1 to 31; null otherwise.
Variant 1: integer
integerVariant 2: null
nulldescriptionstring | nullrequiredLonger detail copied onto each task filed.
Show description schema
string | nullLonger detail copied onto each task filed.
Variant 1: string
stringVariant 2: null
nulldue_offset_daysintegerrequiredHow many days after its scheduled day each task falls due.
estimated_coststring | nullrequiredA work order template's estimate, as a decimal string; null when there is none.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show estimated_cost schema
string | nullA work order template's estimate, as a decimal string; null when there is none.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredThe facility the template files at.
Format: uuid
facility_namestringrequiredThat facility's name.
idstringrequiredThe template's id.
Format: uuid
inspection_kindstring | nullrequiredAn inspection template's kind of round; null otherwise.
Show inspection_kind schema
string | nullAn inspection template's kind of round; null otherwise.
Variant 1: string
stringVariant 2: null
nullinterval_countintegerrequiredEvery how many days, weeks or months.
is_activebooleanrequiredFalse while the template is paused.
kindstringrequiredWhat each run files: task, work_order or inspection.
last_run_onstring | nullrequiredThe last scheduled day a run handled; null before the first.
Format: date
Show last_run_on schema
string | nullThe last scheduled day a run handled; null before the first.
Variant 1: string
stringVariant 2: null
nullnext_run_onstringrequiredThe next scheduled day, in the facility's calendar.
Format: date
prioritystringrequiredHow urgent each task filed is.
requires_photo_proofboolean | nullrequiredWhether 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 | nullWhether 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
booleanVariant 2: null
nullskip_if_openbooleanrequiredTrue skips a scheduled day while a task this template filed is still open.
task_typestringrequiredThe board type of each task filed. A work order or inspection template's is its kind.
titlestringrequiredWhat each task filed is called.
unit_group_idstring | nullrequiredThe unit group an inspection template's rounds cover; null for the whole facility or another kind.
Format: uuid
Show unit_group_id schema
string | nullThe unit group an inspection template's rounds cover; null for the whole facility or another kind.
Variant 1: string
stringVariant 2: null
nullupdated_atstringrequiredWhen it last changed.
Format: date-time
vendorstring | nullrequiredA work order template's vendor; null when there is none.
Show vendor schema
string | nullA work order template's vendor; null when there is none.
Variant 1: string
stringVariant 2: null
nullweekdayinteger | nullrequiredA weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.
Show weekday schema
integer | nullA weekly template's day of the week, 1 (Monday) to 7 (Sunday); null otherwise.
Variant 1: integer
integerVariant 2: null
nullwork_order_categorystring | nullrequiredA work order template's trade category; null otherwise.
Show work_order_category schema
string | nullA work order template's trade category; null otherwise.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope 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