Work Item

Work Item Object

Field	Type	Description
id	snowflake	the work item's id
nonce	snowflake	anti-replay token for the work item
organisation_id	snowflake	the id of the organisation
totp_token	string	one-time password token for QR sign-in flow
number	snowflake	the sequential number for the work item within an organisation
formatted_number	string	human-readable formatted number (e.g. "PRJ-001")
summary	string	a short summary of the work item
details	work item details object	detailed description of the work item (copy-on-write immutable object)
status_id	snowflake	the id of the work item status
status	work item status object	the status of the work item (full object or partial with only id)
priority_id	snowflake	the id of the work item priority
priority	work item priority object	the priority of the work item (full object or partial with only id)
type_id	snowflake	the id of the work item type
type	work item type object	the type of work item (full object or partial with only id)
sub_type_id	snowflake?	the id of the work item sub-type
sub_type	work item sub-type object	the sub-type of the work item (full object or partial with only id)
project_id	snowflake?	the id of the project
project	project object	the project (full object or partial with only id)
milestone_id	snowflake?	the id of the milestone
milestone	milestone object	the milestone (full object or partial with only id)
package_id	snowflake?	the id of the package
package	package object	the package (full object or partial with only id)
discipline_id	snowflake?	the id of the discipline
discipline	discipline object	the discipline (full object or partial with only id)
location_id	snowflake?	the id of the location
location	location object	the location (full object or partial with only id)
fleet_id	snowflake?	the id of the fleet
fleet	fleet object	the fleet (full object or partial with only id)
asset_group_id	snowflake?	the id of the asset group
asset_group	asset group object	the asset group (full object or partial with only id)
asset_id	snowflake?	the id of the asset
asset	asset object	the asset the work item is raised against (full object or partial with only id)
asset_zone_id	snowflake?	the id of the asset zone
asset_zone	asset zone object	the asset zone (full object or partial with only id)
system_id	snowflake?	the id of the system
system	system object	the system the work item is raised against (full object or partial with only id)
progress	number	the current progress value (interpretation depends on progress_type)
progress_type	work item progress type	how to interpret the progress value
due_at	ISO8601 timestamp?	due date/time for the work item
hours_estimated	integer?	estimated duration in hours
hours_actual	integer?	actual duration in hours
scheduled_start_at	ISO8601 timestamp?	scheduled start time (first schedule)
scheduled_finish_at	ISO8601 timestamp?	scheduled finish time (last schedule)
actual_start_at	ISO8601 timestamp?	actual start time
actual_finish_at	ISO8601 timestamp?	actual finish time
visibility	work item kanban visibility	kanban board visibility setting
confidentiality	work item confidentiality	confidentiality level of the work item
assigned_users	array<user object>	users assigned to the work item
assigned_teams	array<team object>	teams assigned to the work item
schedules	array<work item schedule>	schedule entries for the work item
logged_at	ISO8601 timestamp	when the work item was logged on the user's device
created_by	user object	the creator of the work item (full object or partial with only id)
created_at	ISO8601 timestamp	when the work item was created
updated_by	user object	the user who last updated the work item (full object or partial with only id)
updated_at	ISO8601 timestamp	when the work item was last updated
closed_by	user object	the user who closed the work item (full object or partial with only id)
closed_at	ISO8601 timestamp?	when the work item was closed
document_id	snowflake?	the id of the document this work item is raised against
document	document object	the document (full object or partial with only id)
document_branch_id	snowflake?	the id of the document branch
document_branch_name	string	the name of the document branch
document_branch	document branch object	the document branch (full object or partial with only id)
document_revision_id	snowflake?	the id of the document revision
document_revision	document revision object	the document revision (full object or partial with only id)
document_clause_id	snowflake?	the id of the document clause
template_document_id	snowflake?	the id of the template document
template_document	document object	the template document (full object or partial with only id)
template_branch_id	snowflake?	the id of the template document branch
template_branch_name	string	the name of the template branch
template_branch	document branch object	the template branch (full object or partial with only id)
template_tag_id	snowflake?	the id of the template document tag
template_tag	document tag object	the template tag (full object or partial with only id)
inductions	array<induction revision>	induction revisions associated with the work item
parent_work_item_id	snowflake?	the id of the parent work item
checklist_items	array<work item checklist item>	checklist items for the work item
buttons	array<work item action>	available actions/buttons for the work item
timezone_code	string	timezone code (used when no location is specified)
stage	string	the current stage of the work item
updated_fields	array	list of field keys that were updated in the last save
incoming_links	array<incoming link>	items linking to this work item
attachment_count	integer	number of attachments on the work item
comment_count	integer	number of comments/logs on the work item
open_work_item_count	integer	number of open child work items
closed_work_item_count	integer	number of closed child work items
work_item_types_count	object<snowflake, work item type count>	dictionary mapping work-item-type ids to their open/closed counts
permissions	object<permission, boolean>	permission flags for the caller (e.g. CREATE_WORKITEMS, WORK_WORKITEMS)
subscription	work item subscription	subscription/tracking info for the requesting user
last_work_log_id	snowflake?	the id of the most recent work log entry
tracking	work item track	tracking information for the work item
fields	object<snowflake, { id:string, name:string?, type:integer, multiple:boolean, value:any, units:string? }>	custom field values keyed by field id; each entry contains the field's metadata and stored value

Work Item Details Object

Work item details are stored as immutable (copy-on-write) objects with full history preserved via SHA-256 hashing. The details field content is truncated when returned with partial JSON (first 128 characters for title partial, full content for body partial).

Field	Type	Description
id	snowflake	the details object's id
details	string	the detailed description content (up to 262,144 characters); may be truncated based on partial JSON level
content_type	string	MIME type of the content (text/plain, text/markdown, application/rtf, text/html)
hash	string	SHA-256 hash of the details content (64-character hex)
updated_at	ISO8601 timestamp	when the details were last updated
updated_by	user object	the user who last updated the details (partial with only id)

Work Item Type Object

Work items can have different types. These types either map to an asset type or to a document type, and may include workflow metadata, default assignments, report templates, and field/sub-type definitions.

Field	Type	Description
id	snowflake	the work item type's id
organisation_id	snowflake	the id of the organisation
organisation	organisation object	the organisation (full object or partial with only id)
enabled	boolean	whether this work item type is enabled
name	string	the work item type's name
description	string	a description of the work item type
readme	string	long-form guidance or instructions for the work item type
scheduling	work item scheduling	scheduling requirements for work items of this type
send_reminders	boolean	whether reminders should be sent for work items of this type
sign_on_close	work item sign on close	whether sign-off is required when the work item is closed
sub_type_required	work item field required	whether a sub-type must be selected for this work item type
project_required	work item field required	whether a project must be selected for this work item type
package_required	work item field required	whether a package must be selected for this work item type
asset_required	work item field required	whether an asset must be selected for this work item type
system_required	work item field required	whether a system must be selected for this work item type
discipline_required	work item field required	whether a discipline must be selected for this work item type
fleet_id	snowflake?	the id of the default fleet for this work item type
fleet	fleet object	the default fleet (full object or partial with only id)
prefix_id	snowflake	the id of the prefix used for numbering work items of this type
prefix	prefix object	the prefix object (full object or partial with only id)
default_priority_id	snowflake?	the id of the default work item priority
default_project_id	snowflake?	the id of the default project
default_project	project object	the default project (full object or partial with only id)
default_confidentiality	work item confidentiality	default confidentiality for work items of this type
default_details_content_type	string	default MIME type for work item details content
default_field_values	object<snowflake, object>	default custom field values keyed by field id
report_title	string	title used in generated reports for this work item type
report_sections	object<work item report section, work item report section options>	report section display and ordering options
report_template_name	string	file name of the report template
report_template_hash	string	hash of the report template file
default_table_columns	array<work item table column definition>	default report table column definitions
fields	array<work item type field>	fields defined for this work item type
sub_types	array<work item sub-type>	allowed sub-types for this work item type

Work Item Type Field Object

Fields that define a work item type and how the field is rendered for that type.

Field	Type	Description
order	integer	display order for this field on the work item type
field	work item field object	the referenced field (full object or partial with only id)
report_format	string	report display format for this field
notification_format	string	notification display format for this field

Work Item Type Question Object

A link between a work item type and a pre-attendance check-in question.

Field	Type	Description
work_item_type_id	snowflake	the id of the associated work item type
work_item_type	work item type object	the work item type (full object or partial with only id)
check_in_question_id	snowflake	the id of the linked check-in question
check_in_question	object	the linked check-in question object
order	integer	display order for this question within the work item type

Work Item Scheduling

Work item scheduling defines what date/time/location information is required for a work item.

Value	Description
unscheduled	no scheduling required
unscheduled_no_location	no scheduling and no location required
date	work item requires a date
date_and_time	work item requires a date and time
date_time_and_finish_location	work item requires date, time, and finish location (e.g. transport route)

Work Item Sign On Close

Whether signing is required when a work item is closed.

Value	Description
no	signing is not required
optional	signing is optional
required	signing is required

Work Item Report Section

Sections that may appear in generated work item reports.

Value	Description
header_fields	header field section
body_fields	body field section
footer_fields	footer field section
header_results	header results section
body_results	body results section
footer_results	footer results section
attachments	attachment section
logs	log section
invitees	invitee section
witnesses	witness section
links_document_clause	document clause links section
links_model_block	model block links section
links_hyperlink	hyperlink links section
links_work_item	work item links section

Work Item Report Section Options

Options for a work item report section. Specific section types may include additional properties such as title, style, columns, id_label, select, and path.

Field	Type	Description
order	integer	ordering of the section within the report
title	string	section title displayed in the report
style	work item report section table style	optional styling for section display

Work Item Report Section Table Style Object

Styling options for report sections and tables.

Field	Type	Description
table_header	boolean	whether the table header is shown
table_borders	string?	table border style
header_background_color	string	hex colour for the header background
header_color	string	hex colour for the header text
header_font_weight	string	font weight for the header
header_font_style	string	font style for the header
header_font_underline	string	text decoration for the header
header_font_size	number?	font size for the header
header_text_align	string	horizontal alignment for header text
header_vertical_align	string	vertical alignment for header text
background_color	string	hex colour for the cell background
color	string	hex colour for the cell text
font_weight	string	font weight for the cell text
font_style	string	font style for the cell text
font_underline	string	text decoration for the cell text
font_size	number?	font size for the cell text
text_align	string	horizontal alignment for the cell text
vertical_align	string	vertical alignment for the cell text

Work Item Table Column Definition Object

Defines a default report table column for work items.

Field	Type	Description
name	string	name of the column
width	integer	width of the column in the report
format	string	output format for the column
header_background_color	string	hex colour for the header background
header_color	string	hex colour for the header text
header_font_weight	string	font weight for the header
header_font_style	string	font style for the header
header_font_underline	string	text decoration for the header
header_font_size	number?	font size for the header
header_text_align	string	header horizontal alignment
header_vertical_align	string	header vertical alignment
background_color	string	hex colour for the cell background
color	string	hex colour for the text
font_weight	string	font weight for the cell text
font_style	string	font style for the cell text
font_underline	string	text decoration for the cell text
font_size	number?	font size for the cell text
text_align	string	horizontal alignment for cell text
vertical_align	string	vertical alignment for cell text

Work Item Field Object

Custom work item fields can be added to extend work items. Field names cannot start with $, cannot be purely numeric, and cannot use any reserved field names.

Field	Type	Description
id	snowflake	the work item field's id
organisation_id	snowflake	the id of the organisation
required	work item field required	when the field value is required (optional, on open, on close, or never)
is_result	boolean	whether the field collects result data (observations/instrument readings)
name	string	the field's name (max 200 characters, cannot be reserved or start with $)
description	string	a description of the field
type	work item field data types	the data type of the field
units	string	measurement units (e.g. "kg", "m")
multi_line	boolean	whether the field accepts multi-line text input
max_length	integer?	maximum allowed length of a string value
auto_link_work_items	boolean	whether values automatically create links to other work items
auto_link_document_collection_clauses	snowflake?	the id of the document collection clause to auto-link to
auto_link_verb	Link Verb	the verb used when auto-linking
include_in_report	work item field report	where the field appears in generated reports
include_in_report_properties	boolean	whether field metadata appears in report properties
multiple	boolean	whether enum fields allow multiple selections
checklist_has_comments	boolean	whether checklist items for this field can have comments
default_value	any	the default value for the field (type depends on type)
values	array<work item field enum value>	enumeration values for enum-type fields
checklist_items	array<work item field checklist item>	checklist items associated with this field

Work Item Field Required

Value	Description
optional	field is optional, shown on create/edit screens
required_on_open	field is required when the work item is opened, shown on create/edit screens
required_on_close	field is required when the work item is closed, shown only on close screen
never	field is hidden from all screens (used for internal/system fields)

Work Item Field Report

Value	Description
none	field does not appear in reports
header	field appears in the report header
body	field appears in the report body
footer	field appears in the report footer
properties	field metadata appears in report properties
header_and_properties	field appears in header and properties
body_and_properties	field appears in body and properties
footer_and_properties	field appears in footer and properties

Work Item Field Data Types

Value	Name	Description
0	string	an array of characters up to 255
1	integer	a 32 bit signed integer number
2	double	an IEEE 754-2008 double precision floating point number
3	ISO8601 timestamp	a date and time
4	boolean	true or false
10	user	a snowflake id for a user

Reserved Work Item Field Names

The following field names are reserved and cannot be used for custom work item fields:

id, nonce, number, number_formatted, prefix, prefix_id, organisation, organisation_id, type, type_id, sub_type, sub_type_id, summary, details, status, status_id, andon, andon_id, priority, priority_id, fleet, fleet_id, asset_group, asset_group_id, asset, asset_id, system, system_id, asset_zone, asset_zone_id, location, location_id, project, project_id, milestone, milestone_id, package, package_id, discipline, discipline_id, hours_estimated, hours_actual, logged_at, logged_by, logged_by_id, created_at, created_by, created_by_id, updated_at, updated_by, updated_by_id, closed_at, closed_by, closed_by_id, is_deleted, deleted_at, deleted_by, deleted_by_id, progress_type, due_at, has_due_time, timezone_code, comments, comment_count, open_work_item_count, closed_work_item_count, work_item_types_count, parent_work_item_id, visibility, fields, last_work_log_id, signed, signature, document_id, document, document_branch_id, document_branch, document_revision_id, document_revision, document_clause_id, template_document_id, template_document, template_branch_id, template_branch, template_tag_id, template_tag, permissions, subscription, tracking, checklist_items, buttons, stage, updated_fields, incoming_links

Work Item Field Enum Value Object

Enumeration values for enum-type work item fields.

Field	Type	Description
id	snowflake	the enum value's id
value	string	the textual value of the enum entry
order	integer?	the display order of the enum value
updated_at	ISO8601 timestamp	when the enum value was last updated
workitem_field_id	snowflake	the id of the parent work item field (deprecated)
work_item_field_id	snowflake	the id of the parent work item field
updated_by	object<{ id: snowflake }>	the user who last updated the enum value (id only)

Work Item Status Object

Work items have a status. Statuses control the workflow state of the work item and can be configured to represent open or closed states. Statuses are displayed left-to-right on the kanban board in order of their order value.

Field	Type	Description
id	snowflake	the work item status' id
organisation_id	snowflake	the id of the organisation
name	string	the status' name (2-200 characters)
in_progress	boolean	whether work items in this status are considered in progress
closed	boolean	whether work items in this status are considered closed
description	string	a description of the status
enabled	boolean	whether the status is active and available for use
order	integer	display order on kanban board (lower values appear left)

Work Item Priority Object

Work items have a priority assigned. Priorities are ordered numerically (e.g. High = 1, Medium = 2, Low = 3).

Field	Type	Description
id	snowflake	the work item priority's id
name	string	the priority's name (2-20 characters)
description	string	a description of the priority
color	string	hex colour value (e.g. "#FF0000")
organisation_id	snowflake	the id of the organisation
order	integer	display order (lower values appear first)

Work Item Log Object

Work item logs form a timeline of activity including comments, field changes, attachments, actions, duration entries, and link changes.

Field	Type	Description
id	snowflake	the work item log's id
work_item_id	snowflake	the work item's id
type	work item log type	the type of log entry
log	work item log text object	the log content (immutable copy-on-write object, or { id, hash } if truncated)
embed	work item log embed	embedded data associated with the log entry
attachment	work item log attachment	attachment associated with the log entry
asset_group_id	snowflake?	the id of the asset group
asset_group	asset group object	the asset group (full object or partial with only id)
duration	integer?	effort spent on the work item in seconds
latitude	number?	latitude coordinate where the log was created
longitude	number?	longitude coordinate where the log was created
added_links	array<work item link>	links added to the work item (delta)
removed_links	array<work item link>	links removed from the work item (delta)
logged_at	ISO8601 timestamp	when the log was created on the user's device (user-settable)
created_by	user object	the user who created the log entry (full object or partial with only id)
created_at	ISO8601 timestamp	when the log entry was created
updated_by	user object	the user who last updated the log entry (full object or partial with only id)
updated_at	ISO8601 timestamp	when the log entry was last updated
nonce	snowflake	anti-replay token for the log entry

Work Item Log Type

Value	Description
comment	a comment or text entry
field_change	a custom field value was changed
attachment	an attachment was added
action	an action was performed on the work item
hours	effort/duration was logged
links_change	links were added or removed (see added_links and removed_links)

Work Item Log Text Object

Immutable (copy-on-write) log text content with SHA-256 hash for integrity verification.

Field	Type	Description
id	snowflake	the log text's id
hash	string	SHA-256 hash of the log content (64-character hex)
log	string	the log text content (up to 65,536 characters)
updated_at	ISO8601 timestamp	when the log text was last updated
updated_by	user object	the user who last updated the log text (full object or partial with only id)

Work Item Log Embed Object

Embedded data associated with a log entry, typically used to display structured information in a rich card format.

Field	Type	Description
title	string	the embed's title
description	string	the embed's description
fields	array<work item log embed field>	structured fields within the embed

Work Item Log Embed Field Object

Individual field within a work item log embed. The value type depends on type:

• reference types (SubType, Priority, Status, System, User, Fleet, AssetGroup, Asset, AssetZone, Location, Project, ProjectMilestone, ProjectPackage, Discipline) are serialized as string IDs
• DateTime values are converted to ISO8601 timestamps
• Date values are passed through as strings

Field	Type	Description
name	string	the field's name/label
type	Item Field Type	the data type of the field
value	any	the field's value (type depends on type, see above)
inline	boolean?	whether the field should be displayed inline

Work Item Log Attachment Object

Attachment associated with a work item log entry. Files are hashed and stored by their hash name.

Field	Type	Description
id	snowflake	the attachment's id
content_type	string	the attachment's MIME type
length	integer	the attachment's size in bytes
file_name	string	the attachment's filename
file_hash	string	SHA-256 hash of the file content
height	integer?	image height in pixels (for image attachments)
width	integer?	image width in pixels (for image attachments)
created_at	ISO8601 timestamp	when the attachment was created
created_by	object<{ id: snowflake }>	the user who created the attachment (id only)

Work Item Link Object

Link between work items or other objects, used in added_links and removed_links.

Field	Type	Description
source_id	snowflake	the source object's id
target_id	snowflake	the target object's id
verb	string	the relationship verb (e.g. "relates_to", "blocks")

Work Item Attachment

Work items can have files and photos attached to them. Attachments are public to anyone invited to participate in the work item. Private attachments are added to the work item log instead. Public attachments typically represent inputs from planning; private attachments represent outcomes from execution.

Field	Type	Description
id	snowflake	the work item attachment's id
work_item_id	snowflake	the work item's id
file_name	string	the attachment's filename
content_type	string	the attachment's MIME type
length	snowflake	the attachment's size in bytes
file_hash	string	SHA-256 hash of the file content (files are stored by hash)
height	integer?	image height in pixels (for image attachments)
width	integer?	image width in pixels (for image attachments)
created_at	ISO8601 timestamp	when the attachment was uploaded
created_by	user object	the user who uploaded the attachment (partial with only id)

Work Item Schedule Object

Work items can be scheduled across one or more days/shifts. Schedules can be static (occurring at a single location) or dynamic (between two locations). An example would be a test flight between two airports.

Field	Type	Description
id	snowflake	the work item schedule's id
organisation_id	snowflake	the id of the organisation
work_item_id	snowflake	the id of the parent work item
schedule_index	integer	the schedule's position in the work item's schedule sequence
edit_count	integer	number of times this schedule has been edited
token	token	a randomised 6-character reference number for the schedule
status	work item schedule status	current status of the schedule
scheduled_start_at	ISO8601 timestamp	the scheduled start time
scheduled_finish_at	ISO8601 timestamp	the scheduled finish time
actual_start_at	ISO8601 timestamp?	the actual start time or null
actual_finish_at	ISO8601 timestamp?	the actual finish time or null
cancelled_at	ISO8601 timestamp?	when the schedule was cancelled or null
start_location_id	snowflake?	the id of the start location
start_location	location object	the start location (full object or partial with only id)
finish_location_id	snowflake?	the id of the finish location
finish_location	location object	the finish location (full object or partial with only id)
captain_id	snowflake?	the id of the captain user
captain	user object	the user responsible for the schedule (full object or partial with only id)
toolbox_id	snowflake?	the id of the assigned toolbox
invited_users	array<work item schedule invitee>	users invited to participate in this schedule
inductions	array<induction revision>	required induction revisions for this schedule
created_at	ISO8601 timestamp	when the schedule was created
created_by	user object	the user who created the schedule (full object or partial with only id)
updated_at	ISO8601 timestamp	when the schedule was last updated
updated_by	user object	the user who last updated the schedule (full object or partial with only id)
work_item	work item object	the parent work item (included only when requested, otherwise null)

Work Item Schedule Status

Value	Description
pending	schedule is pending confirmation
confirmed	schedule has been confirmed
delayed	schedule is delayed
started	schedule has started
finished	schedule has finished
canceled	schedule has been cancelled

Work Item Schedule Invitee Object

Work item schedules can have users invited to participate. Invited users receive calendar invitations and may be required to complete check-in questions before participating. Contact details (email, phone) are only visible to callers with INVITE_WORKITEMS or WORK_WORKITEMS permissions; otherwise these fields return empty strings.

Field	Type	Description
id	snowflake	the invitee's id
work_item_id	snowflake?	the id of the parent work item (derived from schedule)
organisation_id	snowflake	the id of the organisation
schedule_id	snowflake	the id of the parent work item schedule
token	token	a randomised 6-character reference number for the invitee
user_id	snowflake	the id of the associated user
email	string	the invitee's e-mail (empty string if caller lacks permissions)
phone_number	string	the invitee's mobile phone number (empty string if caller lacks permissions)
first_name	string	the invitee's first name
last_name	string	the invitee's last name
company	string	the invitee's company
position	string	the invitee's position at their company
status	integer	the invitee's current status (see work item schedule invitee status)
reminder_sent	boolean	whether a reminder has been sent to the invitee
check_in_method	integer	how the invitee checked in (see check-in method)
questions	array<check-in question value>	answers to pre-attendance check-in questions
created_at	ISO8601 timestamp	when the invitee was added to the schedule
responded_at	ISO8601 timestamp?	when the invitee responded to the invitation or null
checked_in_at	ISO8601 timestamp?	when the invitee completed check-in or null
attended_at	ISO8601 timestamp?	when the invitee was marked as attending or null
break_at	ISO8601 timestamp?	when the invitee went on break or null
departed_at	ISO8601 timestamp?	when the invitee departed or null
checkout_reason	string	reason provided when the invitee departed

Work Item Schedule Induction Object

A work item schedule induction links a schedule to an induction package. The schedule JSON returns the linked induction revision(s) under inductions, not this linking object directly.

Field	Type	Description
work_item_schedule_id	snowflake	the id of the parent work item schedule
work_item_schedule	work item schedule object	the parent schedule object
induction_id	snowflake	the id of the linked induction
induction	induction object	the induction package
induction_hash	hash	hash of the induction revision this schedule induction is valid for
created_by_id	snowflake	the id of the user who created the schedule induction
created_by	user object	the user who created the schedule induction
created_at	ISO8601 timestamp	when the schedule induction was created

Work Item Schedule Invitee Status

Value	Name	Description
0x00	normal	default state, planning to arrive
0x01	tentative	invitee is tentatively accepting
0x02	accepted	invitee has accepted the invitation
0x20	declined	invitee has declined the invitation
0x03	checked_in	pre-attendance check-in completed
0x04	attending	marked as in attendance
0x05	break	temporary stay of attendance
0x10	departed	no longer in attendance, has alighted

Check In Method

Value	Name	Description
0	self_service_online	self-service check-in via online platform
1	self_service_kiosk	self-service check-in via on-site kiosk
2	assisted	assisted check-in by staff

Check-In Question Value Object

An answer to a pre-attendance check-in question.

Field	Type	Description
id	snowflake	the question's id
question	string	the question text
type	integer	the data type of the answer
value	any	the invitee's answer (type depends on type)

Work Item Progress Type

Value	Description
normal	standard progress percentage (0–100)
time_elapsed	progress based on elapsed time
tasks_complete	progress based on number of completed tasks
certainty	progress represents certainty/confidence level

Work Item Confidentiality

Value	Description
external	most permissible, visible to external parties (default)
internal	visible only to organisation members
limited	visible only to explicitly assigned users and teams
none	no access granted

Work Item Kanban Visibility

Value	Description
normal	standard visibility on kanban board
pinned	pinned to the top of the kanban board
hidden	collapsed, hidden below the fold on kanban board

Work Item Sub-Type Object

Work item sub-types are used to classify a work item within a type.

Field	Type	Description
id	snowflake	the work item sub-type's id
organisation_id	snowflake	the id of the organisation
name	string	the sub-type's name
description	string	a description of the sub-type
enabled	boolean	whether this sub-type is enabled
work_item_type_id	snowflake?	the id of the work item type associated with this sub-type

Work Item Field Checklist Item Object

The template definition of checklist items for a work item field. This defines what checklist items exist (label, order, heading) but does not track completion state. Completion state is tracked by work item checklist items which are instances created when a work item is filled out.

Field	Type	Description
id	snowflake	the checklist item's id
work_item_field_id	snowflake	the id of the parent work item field
label	string	the display label for the checklist item
order	integer?	the display order of the checklist item
heading	boolean	whether the item is a section heading (non-selectable)
updated_at	ISO8601 timestamp	when the checklist item was last updated
updated_by	object<{ id: snowflake }>	the user who last updated the checklist item (id only)

Work Item Checklist Item Object

An instance of a checklist item for a specific work item. This tracks the user's completion state (value) and optional comments. Checklist items may reference a work item field checklist item template, or exist independently when work_item_field_id is null (work-item-level checklists).

Field	Type	Description
id	snowflake	the checklist item's id
work_item_id	snowflake	the id of the work item
work_item_field_id	snowflake?	the id of the work item field, if the checklist item is field-specific
value	boolean	whether the checklist item is checked/completed
comment	string	a comment associated with the checklist item
label	string	the display label for the checklist item
order	integer?	the display order of the checklist item
heading	boolean	whether the item is a section heading (non-selectable)
updated_at	ISO8601 timestamp	when the checklist item was last updated
updated_by	object<{ id: snowflake }>	the user who last updated the checklist item (id only)

Work Item Action Object

Actions (buttons) available for the work item based on current state and permissions.

Field	Type	Description
id	snowflake	the action's id
name	string	the action's display name
description	string	a description of what the action does
enabled	boolean	whether the action is currently available

Work Item Subscription User Object

Subscription information for tracking work item updates.

Field	Type	Description
work_item_id	snowflake	the work item's id
user	object<{ id: snowflake }>	the subscribed user (only id is returned by ToJson)
is_muted	boolean	whether the user has muted notifications for this work item
is_sync	boolean?	whether the work item is synced to the user's device (may be null)

Work Item Track Object

Tracking information for the work item. This object is returned in the tracking field when work item tracking data is included.

Field	Type	Description
last_viewed_at	ISO8601 timestamp	when the work item was last viewed by the current user
last_viewed_log_id	snowflake?	the id of the last work log entry that was viewed

Work Item Type Count Object

Dictionary value mapping work-item-type ids to their open/closed counts. Used in work_item_types_count on the work item object.

Field	Type	Description
open	integer	the number of open work items
closed	integer	the number of closed work items

Work Item Count Object

Aggregated work item counts grouped by object, type, and status. Counts are broken down by confidentiality level so that callers can filter based on their access scope.

Field	Type	Description
object_id	snowflake	the id of the parent object being counted against
object_type	object type	the type of the parent object
type_id	snowflake	the id of the work item type
type	work item type object	the work item type (full object or partial with only id)
status_id	snowflake	the id of the work item status
status	work item status object	the work item status (full object or partial with only id)
count_external	integer	count of work items at external confidentiality level
count_internal	integer	count of work items at internal confidentiality level
count_limited	integer	count of work items at limited confidentiality level

Work Item Counts

The work item counts object returns the number of open and closed work items for each type. The format is a dictionary of counts where each count has the following object format.

Work Item Count

Field	Type	Description
open	integer	The number of open work items
closed	integer	The number of closed work items

Create Work Item

POST /organisations/{organisation.id}/workitems

Parameters

Field	Type	Description
summary	string	a short summary of the work item (2-100 characters)
details	string	a long description of the work item (up to 16000 characters)

Update Work Item

PATCH /organisations/{organisation.id}/workitems/{workitem.id}

Update Work Item Schedule

PATCH /organisations/{organisation.id}/workitems/{workitem.id}/schedules/{schedule.id}

Parameters

Field	Type	Description
actual_start_at	?ISO8601 timestamp	the actual start time of the work item schedule
actual_finish_at	?ISO8601 timestamp	the actual finish time of the work item schedule