API: objects and fields: AperioFlow

The objects named in the endpoint chapters. A field marked Required must be sent when the object is created; read-only fields (such as id, progress and created_at) are filled in by the server and ignored if you send them back.

ActionsMinutes

Field	Type	Required	Description
`enabled`	boolean	No	The server can read usage through GitHub (GITHUB_APP is on with its App id and key and/or its sign-in client)
`connection`	object	No	Whether this organisation can be read now: state is ok, off, not_connected, needs_permission, needs_reconnect, not_configured or unavailable, with a fixed message.
`error_code`	string or null	No	A fixed word for why the last read failed (the same words as connection.state)
`month`	string	No
`allowance`	integer	No	GHA_MONTHLY_MINUTES.
`reserve`	integer	No	GHA_RESERVE_MINUTES.
`used`	integer	No
`left`	integer	No
`percent`	integer	No
`charged`	number	No	Charged beyond the plan (USD)
`allocated`	integer	No
`unallocated`	integer	No
`fetched_at`	string or null (date-time)	No
`stale`	boolean	No	Not read for over 6 hours.
`error`	string or null	No
`failed_at`	string or null (date-time)	No
`projects`	array of `ActionsProjectMinutes`	No
`unmatched`	array of object	No

ActionsProjectMinutes

Field	Type	Required	Description
`project_id`	integer	No
`name`	string	No
`status`	string	No
`repo`	string or null	No	owner/name from repo_url.
`allowance`	integer or null	No
`used`	integer	No	Minutes counted against the plan (runner multiplier applied)
`left`	integer or null	No
`percent`	integer or null	No
`over`	boolean	No
`by_sku`	array of object	No

Activity

Field	Type	Required	Description
`id`	integer	Yes
`project_id`	integer or null	No
`entity_type`	string	Yes	One of: `project`, `phase`, `task`, `subtask`, `issue`.
`entity_id`	integer	Yes
`entity_name`	string or null	No
`action`	string	Yes	One of: `created`, `updated`, `deleted`.
`changes`	object or null	No	For `updated`: each changed field as `{ "from": ..., "to": ... }`. For `created` with nested items: `{ "nested_items": <count> }`.
`source`	string	Yes	One of: `api`, `web`.
`actor`	string or null	No
`created_at`	string (date-time)	Yes

Comment

Field	Type	Required	Description
`id`	integer	No
`entity_type`	string	No	One of: `task`, `subtask`, `issue`.
`entity_id`	integer	No
`user_id`	integer or null	No	Null once the author has deleted their account.
`author`	string or null	No	The author's name.
`body`	string	No	The Markdown as written.
`body_html`	string	No	Rendered on the server.
`created_at`	string (date-time)	No
`edited_at`	string or null (date-time)	No

DailySummarySetting

Field	Type	Required	Description
`enabled`	boolean	No	Default `false`.
`hour`	integer	No	Default `8`. From 0 to 23.
`time_zone`	string	No	An IANA time zone name. Default `"Europe/London"`. Up to 64 characters.

DateOrNull

Type: string or null (date).

Description

Type: string or null. Up to 20000 characters.

Device

Field	Type	Required	Description
`id`	integer	No
`platform`	string	No	One of: `ios`, `android`, `web`.
`label`	string	No
`notify_down`	boolean	No	Starts off.
`notify_overdue`	boolean	No	Starts off.
`notify_mentions`	boolean	No	Starts off.
`notify_assigned`	boolean	No	Starts off.
`summary_hour`	integer or null	No	Starts null: no morning summary.
`time_zone`	string or null	No
`created_at`	string (date-time)	No
`last_used_at`	string (date-time)	No

Error

Field	Type	Required	Description
`error`	string	Yes
`details`	array of object	No

IngestKey

Field	Type	Required
`project_id`	integer	Yes
`ingest_key`	string	Yes
`ingest_path`	string	Yes

Issue

Field	Type	Required	Description
`id`	integer	Yes
`project_id`	integer	Yes
`fingerprint`	string	Yes
`title`	string	Yes	From the latest event: `type: first line of message`.
`type`	string or null	No
`level`	`IssueLevel`	Yes	One of: `fatal`, `error`, `warning`, `info`. Default `"error"`.
`status`	`IssueStatus`	Yes	One of: `open`, `resolved`, `ignored`.
`route`	string or null	No
`platform`	string or null	No
`environment`	string or null	No
`event_count`	integer	Yes
`first_seen`	string (date-time)	Yes
`last_seen`	string (date-time)	Yes
`resolved_at`	string or null (date-time)	No
`created_at`	string (date-time)	No
`updated_at`	string (date-time)	No

IssueCounts

Field	Type	Required
`total`	integer	Yes
`open`	integer	Yes
`resolved`	integer	Yes
`ignored`	integer	Yes

IssueDetail

Field	Type	Required	Description
`id`	integer	Yes
`project_id`	integer	Yes
`fingerprint`	string	Yes
`title`	string	Yes	From the latest event: `type: first line of message`.
`type`	string or null	No
`level`	`IssueLevel`	Yes	One of: `fatal`, `error`, `warning`, `info`. Default `"error"`.
`status`	`IssueStatus`	Yes	One of: `open`, `resolved`, `ignored`.
`route`	string or null	No
`platform`	string or null	No
`environment`	string or null	No
`event_count`	integer	Yes
`first_seen`	string (date-time)	Yes
`last_seen`	string (date-time)	Yes
`resolved_at`	string or null (date-time)	No
`created_at`	string (date-time)	No
`updated_at`	string (date-time)	No
`project_name`	string	No
`events`	array of `IssueEvent`	Yes

IssueEvent

Field	Type	Required	Description
`id`	integer	No
`issue_id`	integer	No
`message`	string	No
`type`	string or null	No
`level`	`IssueLevel`	No	One of: `fatal`, `error`, `warning`, `info`. Default `"error"`.
`url`	string or null	No
`stack`	string or null	No
`platform`	string or null	No
`environment`	string or null	No
`release`	string or null	No
`user_agent`	string or null	No
`context`	object or null	No
`occurred_at`	string (date-time)	No
`received_at`	string (date-time)	No

IssueEventBatch

Type: IssueEventCreate or array of IssueEventCreate.

IssueEventCreate

Field	Type	Required	Description
`message`	string	Yes	At least 1 character. Up to 10000 characters.
`type`	string or null	No	Up to 200 characters.
`level`	`IssueLevel`	No	One of: `fatal`, `error`, `warning`, `info`. Default `"error"`.
`url`	string or null	No	Page or endpoint where it happened. Up to 2000 characters.
`route`	string or null	No	Route pattern to group by, e.g. `/invoices/<id>`. Derived from `url` when omitted. Up to 500 characters.
`stack`	string or null	No	Up to 50000 characters.
`platform`	string or null	No	Up to 100 characters.
`environment`	string or null	No	Up to 100 characters.
`release`	string or null	No	Up to 200 characters.
`user_agent`	string or null	No	Up to 500 characters.
`fingerprint`	string or null	No	Your own grouping key. Events with the same fingerprint always share an issue. Up to 200 characters.
`occurred_at`	string or null (date-time)	No	Defaults to when it was received.
`context`	object or null	No	Any extra data (up to 20 KB as JSON).

IssueLevel

Type: string. One of: fatal, error, warning, info. Default "error".

IssueListItem

Field	Type	Required	Description
`id`	integer	Yes
`project_id`	integer	Yes
`fingerprint`	string	Yes
`title`	string	Yes	From the latest event: `type: first line of message`.
`type`	string or null	No
`level`	`IssueLevel`	Yes	One of: `fatal`, `error`, `warning`, `info`. Default `"error"`.
`status`	`IssueStatus`	Yes	One of: `open`, `resolved`, `ignored`.
`route`	string or null	No
`platform`	string or null	No
`environment`	string or null	No
`event_count`	integer	Yes
`first_seen`	string (date-time)	Yes
`last_seen`	string (date-time)	Yes
`resolved_at`	string or null (date-time)	No
`created_at`	string (date-time)	No
`updated_at`	string (date-time)	No
`project_name`	string	No
`last_event`	`IssueEvent` or null	No	The latest event, without `stack` and `context`.

IssueStatus

Type: string. One of: open, resolved, ignored.

IssueSummaryCounts

Field	Type	Required	Description
`total`	integer	No
`open`	integer	No
`resolved`	integer	No
`ignored`	integer	No
`open_by_level`	object	No
`new_24h`	integer	No	Issues first seen in the last 24 hours.
`events_24h`	integer	No	Events received in the last 24 hours (of those still stored)
`last_seen`	string or null (date-time)	No

ItemBase

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes

Label

Field	Type	Required	Description
`id`	integer	No
`name`	string	No
`color`	`LabelColor`	No	One of: `gray`, `red`, `orange`, `yellow`, `green`, `teal`, `blue`, `purple`, `pink`.
`task_count`	integer	No	How many tasks carry it.
`created_at`	string (date-time)	No

LabelColor

Type: string. One of: gray, red, orange, yellow, green, teal, blue, purple, pink.

LabelInput

Field	Type	Required	Description
`name`	string	No	Unique in the organisation. At least 1 character. Up to 40 characters.
`color`	`LabelColor`	No	One of: `gray`, `red`, `orange`, `yellow`, `green`, `teal`, `blue`, `purple`, `pink`.

Name

Trimmed; must not be blank.

Type: string. At least 1 character. Up to 300 characters.

Owner

Type: string or null. Up to 200 characters.

OwnerUserId

The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.

Type: integer or null.

ParentId

Type: integer. From 1 to 2147483647.

Phase

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`project_id`	integer	Yes
`kind`	`PhaseKind`	Yes	`build` for a build phase, otherwise the section kind. One of: `build`, `regular`, `awaiting_owner`, `awaiting_response`. Default `"build"`.
`tasks`	array of `Task`	Yes

PhaseCreate

Field	Type	Required	Description
`project_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	Yes	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`kind`	string	No	Only `build` is accepted. Sections are created by moving a task into one, or by creating a task with `section`. One of: `build`.
`tasks`	array of `TaskCreate`	No

PhaseKind

build for a build phase, otherwise the section kind.

Type: string. One of: build, regular, awaiting_owner, awaiting_response. Default "build".

PhaseUpdate

Field	Type	Required	Description
`project_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	No	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`kind`	`PhaseKind`	No	`build` for a build phase, otherwise the section kind. One of: `build`, `regular`, `awaiting_owner`, `awaiting_response`. Default `"build"`.

Position

Sort order among siblings. New items are added at the end by default.

Type: integer.

Priority

Type: string. One of: low, medium, high, critical. Default "medium".

Project

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`repo_url`	string or null	No
`task_key`	`TaskKey`	No	The start of every task key in the project (a task is `AF-12`). Unique in the organisation; a clash is a 400 on `task_key`. Made from the name's initials when not given on create.
`ingest_key`	string	No	Key for `POST /ingest/{key}`. Rotate it with `POST /api/projects/{id}/ingest-key`.
`issue_counts`	`IssueCounts`	No	Issues by status, not counting CrowdSec security alerts (platform `crowdsec`).
`security_counts`	`IssueCounts`	No	CrowdSec security alerts (platform `crowdsec`) by status. They send no push notifications.
`phases`	array of `Phase`	Yes
`summary`	`Summary`	Yes	Item counts by status at each level of the project, over its build phases. Sections are counted in `sections`.

ProjectActionsMinutes

Field	Type	Required	Description
`project_id`	integer	No
`name`	string	No
`status`	string	No
`repo`	string or null	No	owner/name from repo_url.
`allowance`	integer or null	No
`used`	integer	No	Minutes counted against the plan (runner multiplier applied)
`left`	integer or null	No
`percent`	integer or null	No
`over`	boolean	No
`by_sku`	array of object	No
`month`	string	No
`planned`	integer	No
`fits`	boolean	No
`reasons`	array of string	No
`account`	object	No
`fetched_at`	string or null (date-time)	No
`stale`	boolean	No
`error`	string or null	No

ProjectCreate

Field	Type	Required	Description
`name`	`Name`	Yes	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`repo_url`	`RepoUrl`	No	Up to 2000 characters.
`task_key`	`TaskKey`	No	The start of every task key in the project (a task is `AF-12`). Unique in the organisation; a clash is a 400 on `task_key`. Made from the name's initials when not given on create.
`phases`	array of `PhaseCreate`	No

ProjectListItem

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`repo_url`	string or null	No
`task_key`	`TaskKey`	No	The start of every task key in the project (a task is `AF-12`). Unique in the organisation; a clash is a 400 on `task_key`. Made from the name's initials when not given on create.
`ingest_key`	string	No
`issue_counts`	`IssueCounts`	No	Issues by status, not counting CrowdSec security alerts (platform `crowdsec`).
`security_counts`	`IssueCounts`	No	CrowdSec security alerts (platform `crowdsec`) by status. They send no push notifications.
`summary`	`Summary`	Yes	Item counts by status at each level of the project, over its build phases. Sections are counted in `sections`.
`last_activity_at`	string (date-time)	Yes
`phases`	array of `Phase`	No	Only present with `include=tree`.

ProjectUpdate

Field	Type	Required	Description
`name`	`Name`	No	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`repo_url`	`RepoUrl`	No	Up to 2000 characters.
`task_key`	`TaskKey`	No	The start of every task key in the project (a task is `AF-12`). Unique in the organisation; a clash is a 400 on `task_key`. Made from the name's initials when not given on create.

PushSubscription

Field	Type	Required	Description
`endpoint`	string (uri)	Yes	https URL from the browser push service.
`keys`	object	Yes

RepoUrl

Type: string or null. Up to 2000 characters.

SavedView

Field	Type	Required
`id`	integer	No
`project_id`	integer	No
`name`	string	No
`config`	`SavedViewConfig`	No
`created_at`	string (date-time)	No
`updated_at`	string (date-time)	No

SavedViewConfig

Field	Type	Required	Description
`status`	string	No	One of: (empty), `todo`, `in_progress`, `blocked`, `done`, `cancelled`.
`priority`	string	No	One of: (empty), `low`, `medium`, `high`, `critical`.
`owner`	string	No	An owner's name, or `__none__` for tasks with no owner. Up to 200 characters.
`q`	string	No	Text in a task's name or description. Up to 100 characters.
`sort`	string	No	One of: `phase`, `name`, `status`, `priority`, `owner`, `due`, `updated`. Default `"phase"`.
`dir`	string	No	One of: `asc`, `desc`. Default `"asc"`.
`group`	string	No	One of: (empty), `phase`, `status`, `priority`, `owner`.

SectionKind

regular (Regular tasks), awaiting_owner (Awaiting owner) or awaiting_response (Awaiting response).

Type: string. One of: regular, awaiting_owner, awaiting_response.

SectionTask

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`phase_id`	integer	Yes
`labels`	array of object	No	The task's labels by name. Ignored on write; set them with `PUT /api/tasks/{id}/labels`.
`repeat`	object or null	No	How the task repeats (`freq`, `every_n`, `weekdays`, `month_day`, `ends_on`), or null. Ignored on write; set it with `PUT /api/tasks/{id}/repeat`.
`blocked_by`	array of object	No	The tasks this task waits on (`id`, `key`, `name`, `status`). Ignored on write; set them with `PUT /api/tasks/{id}/blocked-by`.
`project_id`	integer	No	The project the task's phase belongs to. Ignored on write; set `phase_id` to move a task.
`number`	integer	No	The task's number inside its project. Never reused; a task moved to another project gets that project's next number.
`key`	string or null	No	The project's `task_key`, a hyphen and `number` (null while the project has no key).
`origin_phase_id`	integer or null	No	For a task in a section, the build phase it came from (null if none or deleted).
`origin_phase_name`	string or null	No
`subtasks`	array of `Subtask`	Yes
`section`	`SectionKind`	Yes	`regular` (Regular tasks), `awaiting_owner` (Awaiting owner) or `awaiting_response` (Awaiting response). One of: `regular`, `awaiting_owner`, `awaiting_response`.
`section_name`	string	Yes
`project_id`	integer	Yes
`project_name`	string	Yes

Status

Type: string. One of: todo, in_progress, blocked, done, cancelled. Default "todo".

StatusCounts

Field	Type	Required
`total`	integer	Yes
`todo`	integer	Yes
`in_progress`	integer	Yes
`blocked`	integer	Yes
`done`	integer	Yes
`cancelled`	integer	Yes

Subtask

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`task_id`	integer	Yes

SubtaskCreate

Field	Type	Required	Description
`task_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	Yes	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.

SubtaskUpdate

Field	Type	Required	Description
`task_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	No	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.

Summary

Item counts by status at each level of the project, over its build phases. Sections are counted in sections.

Field	Type	Required	Description
`phases`	`StatusCounts`	Yes
`tasks`	`StatusCounts`	Yes
`subtasks`	`StatusCounts`	Yes
`sections`	object	Yes	Open (not done or cancelled) tasks in each section.

Task

Field	Type	Required	Description
`id`	integer	Yes
`name`	string	Yes
`description`	string or null	No
`status`	`Status`	Yes	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	Yes	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	string or null	No
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	integer	Yes
`progress`	number	Yes	Rolled-up completion percentage, to one decimal place. From 0 to 100.
`created_at`	string (date-time)	Yes
`updated_at`	string (date-time)	Yes
`phase_id`	integer	Yes
`labels`	array of object	No	The task's labels by name. Ignored on write; set them with `PUT /api/tasks/{id}/labels`.
`repeat`	object or null	No	How the task repeats (`freq`, `every_n`, `weekdays`, `month_day`, `ends_on`), or null. Ignored on write; set it with `PUT /api/tasks/{id}/repeat`.
`blocked_by`	array of object	No	The tasks this task waits on (`id`, `key`, `name`, `status`). Ignored on write; set them with `PUT /api/tasks/{id}/blocked-by`.
`project_id`	integer	No	The project the task's phase belongs to. Ignored on write; set `phase_id` to move a task.
`number`	integer	No	The task's number inside its project. Never reused; a task moved to another project gets that project's next number.
`key`	string or null	No	The project's `task_key`, a hyphen and `number` (null while the project has no key).
`origin_phase_id`	integer or null	No	For a task in a section, the build phase it came from (null if none or deleted).
`origin_phase_name`	string or null	No
`subtasks`	array of `Subtask`	Yes

TaskCreate

Field	Type	Required	Description
`phase_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	Yes	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`subtasks`	array of `SubtaskCreate`	No

TaskCreateInSection

POST /api/tasks straight into a section of the project, which is created if needed.

Field	Type	Required	Description
`project_id`	`ParentId`	Yes	From 1 to 2147483647.
`section`	`SectionKind`	Yes	`regular` (Regular tasks), `awaiting_owner` (Awaiting owner) or `awaiting_response` (Awaiting response). One of: `regular`, `awaiting_owner`, `awaiting_response`.
`name`	`Name`	Yes	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.
`subtasks`	array of `SubtaskCreate`	No

TaskKey

The start of every task key in the project (a task is AF-12). Unique in the organisation; a clash is a 400 on task_key. Made from the name's initials when not given on create.

Type: string or null.

TaskMove

Exactly one of section or phase_id.

Field	Type	Required	Description
`section`	`SectionKind`	No	`regular` (Regular tasks), `awaiting_owner` (Awaiting owner) or `awaiting_response` (Awaiting response). One of: `regular`, `awaiting_owner`, `awaiting_response`.
`phase_id`	`ParentId`	No	From 1 to 2147483647.

TaskUpdate

Field	Type	Required	Description
`phase_id`	`ParentId`	No	From 1 to 2147483647.
`name`	`Name`	No	Trimmed; must not be blank. At least 1 character. Up to 300 characters.
`description`	`Description`	No	Up to 20000 characters.
`status`	`Status`	No	One of: `todo`, `in_progress`, `blocked`, `done`, `cancelled`. Default `"todo"`.
`priority`	`Priority`	No	One of: `low`, `medium`, `high`, `critical`. Default `"medium"`.
`owner`	`Owner`	No	Up to 200 characters.
`owner_user_id`	`OwnerUserId`	No	The owner as a member of the organisation. Setting it fills owner with their name unless owner is sent too.
`start_date`	`DateOrNull`	No
`due_date`	`DateOrNull`	No
`position`	`Position`	No	Sort order among siblings. New items are added at the end by default.

WorkEmailSetting

Field	Type	Required	Description
`work_emails`	boolean	Yes	On by default.