/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 POST \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/task-templates' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"cadence": "daily",
"title": "string",
"anchor_on": "2026-10-29",
"assignment": {
"mode": "direct",
"user_id": "00000000-0000-4000-8000-000000000001"
},
"day_of_month": 1,
"description": "string",
"due_offset_days": 0,
"estimated_cost": 0,
"inspection_kind": "string",
"interval_count": 1,
"kind": "task",
"priority": "normal"
}'Parameters
facility_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
anchor_onstring | nullThe date the schedule counts from, in the facility's calendar: the first task is filed on the first scheduled day on or after it. Omitted, the facility's today.
Format: date
Show anchor_on schema
string | nullThe date the schedule counts from, in the facility's calendar: the first task is filed on the first scheduled day on or after it. Omitted, the facility's today.
Variant 1: string
stringVariant 2: null
nullassignmentTaskAssignmentRequest | nullWho gets each task filed, in the form the task assign route takes: direct names a person who can be assigned work at this facility, auto gives each task to the facility's rotation, and unassigned leaves it for someone to claim. Omitted, unassigned.
Show assignment schema
TaskAssignmentRequest | nullWho gets each task filed, in the form the task assign route takes: direct names a person who can be assigned work at this facility, auto gives each task to the facility's rotation, and unassigned leaves it for someone to claim. Omitted, unassigned.
Variant 1: TaskAssignmentRequest
modestringrequireddirect assigns user_id; auto gives the task to the next person in its facility's rotation, and it waits when there is no one; unassigned clears the assignee.
Values: "direct", "auto", "unassigned"
user_idstring | nullThe person to assign, with mode direct only.
Format: uuid
Show user_id schema
string | nullThe person to assign, with mode direct only.
Variant 1: string
stringVariant 2: null
nullVariant 2: null
nullcadencestringrequiredHow often a task is filed: daily, weekly or monthly.
Values: "daily", "monthly", "weekly"
day_of_monthinteger | nullThe day of the month, 1 to 31; a day past the end of a shorter month files on its last day. Required with a monthly cadence and refused with any other.
Minimum: 1 · Maximum: 31
Show day_of_month schema
integer | nullThe day of the month, 1 to 31; a day past the end of a shorter month files on its last day. Required with a monthly cadence and refused with any other.
Variant 1: integer
integerVariant 2: null
nulldescriptionstring | nullLonger detail copied onto each task filed. At most 2,000 characters. Empty or only spaces is stored as null.
Max length: 2000
Show description schema
string | nullLonger detail copied onto each task filed. At most 2,000 characters. Empty or only spaces is stored as null.
Variant 1: string
stringVariant 2: null
nulldue_offset_daysintegerHow many days after its scheduled day each task falls due, 0 to 365. 0 is due that day.
Default: 0 · Minimum: 0 · Maximum: 365
estimated_costnumber | string | nullThe estimate each work order carries, as a decimal string: zero or more, at most 99999999.99, with at most two decimal places. Null for none. A work order template's only.
Minimum: 0 · Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show estimated_cost schema
number | string | nullThe estimate each work order carries, as a decimal string: zero or more, at most 99999999.99, with at most two decimal places. Null for none. A work order template's only.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullinspection_kindstring | nullThe kind of round each inspection filed is: lock_audit, fire_life_safety, pest_control, lighting_safety, walkthrough, move_out or general. Required for an inspection template and refused on any other.
Max length: 30
Show inspection_kind schema
string | nullThe kind of round each inspection filed is: lock_audit, fire_life_safety, pest_control, lighting_safety, walkthrough, move_out or general. Required for an inspection template and refused on any other.
Variant 1: string
stringVariant 2: null
nullinterval_countintegerEvery how many days, weeks or months. At most 365 days, 52 weeks or 12 months.
Default: 1 · Minimum: 1 · Maximum: 365
kindstringWhat each run files: task, work_order or inspection. A kind that cannot be scheduled yet answers 400; the list's available_kinds names the kinds that can.
Default: "task" · Values: "inspection", "task", "work_order"
prioritystringHow urgent each task filed is.
Default: "normal" · Values: "low", "normal", "high", "urgent"
requires_photo_proofboolean | nullWhether each task filed needs proof photos before it can be completed. Omitted or null, each task takes the facility's default for its type on the day it is filed. A value that differs from the facility's default needs the task.manage permission, and turning a default of true off needs a person. A false sent by an API key equals the default it was checked against and is stored as null.
Show requires_photo_proof schema
boolean | nullWhether each task filed needs proof photos before it can be completed. Omitted or null, each task takes the facility's default for its type on the day it is filed. A value that differs from the facility's default needs the task.manage permission, and turning a default of true off needs a person. A false sent by an API key equals the default it was checked against and is stored as null.
Variant 1: boolean
booleanVariant 2: null
nullskip_if_openbooleanTrue files nothing on a scheduled day while a task this template filed is still open, and notes the skipped day on that task. False files on every scheduled day.
Default: true
task_typestring | nullThe board type of each task filed. Required for a task template, and never a type that needs a unit: clean_unit, unit_prep, overlock or remove_overlock. A work order or inspection template takes its kind's own name (work_order or inspection) or nothing.
Values: "auction_prep", "clean_unit", "collection", "follow_up", "inspection", "lock_check", "maintenance", "other", "overlock", "remove_overlock", "review", "unit_prep", "walkthrough", "work_order"
Show task_type schema
string | nullThe board type of each task filed. Required for a task template, and never a type that needs a unit: clean_unit, unit_prep, overlock or remove_overlock. A work order or inspection template takes its kind's own name (work_order or inspection) or nothing.
Variant 1: string
stringValues: "auction_prep", "clean_unit", "collection", "follow_up", "inspection", "lock_check", "maintenance", "other", "overlock", "remove_overlock", "review", "unit_prep", "walkthrough", "work_order"
Variant 2: null
nulltitlestringrequiredWhat each task filed is called. Trimmed and required.
Min length: 1 · Max length: 255
unit_group_idstring | nullThe unit group each inspection filed covers: a live unit group of this facility. Omitted for the whole facility. An inspection template's only.
Format: uuid
Show unit_group_id schema
string | nullThe unit group each inspection filed covers: a live unit group of this facility. Omitted for the whole facility. An inspection template's only.
Variant 1: string
stringVariant 2: null
nullvendorstring | nullWho does each work order's work, as typed. At most 120 characters; empty or only spaces is stored as null. A work order template's only.
Max length: 120
Show vendor schema
string | nullWho does each work order's work, as typed. At most 120 characters; empty or only spaces is stored as null. A work order template's only.
Variant 1: string
stringVariant 2: null
nullweekdayinteger | nullThe day of the week, 1 (Monday) to 7 (Sunday). Required with a weekly cadence and refused with any other.
Minimum: 1 · Maximum: 7
Show weekday schema
integer | nullThe day of the week, 1 (Monday) to 7 (Sunday). Required with a weekly cadence and refused with any other.
Variant 1: integer
integerVariant 2: null
nullwork_order_categorystring | nullThe trade each work order needs: doors, electrical, access, building, elevator, pest_control, hvac, security, paving, locks, plumbing, roofing, cleaning, maintenance or other. Required for a work order template and refused on any other.
Values: "doors", "electrical", "access", "building", "elevator", "pest_control", "hvac", "security", "paving", "locks", "plumbing", "roofing", "cleaning", "maintenance", "other"
Show work_order_category schema
string | nullThe trade each work order needs: doors, electrical, access, building, elevator, pest_control, hvac, security, paving, locks, plumbing, roofing, cleaning, maintenance or other. Required for a work order template and refused on any other.
Variant 1: string
stringValues: "doors", "electrical", "access", "building", "elevator", "pest_control", "hvac", "security", "paving", "locks", "plumbing", "roofing", "cleaning", "maintenance", "other"
Variant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
201Successful Response
{
"data": {
"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
dataTaskTemplateResponserequiredOne recurring template, with what the caller may do with it.
Show data 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