Labels
List active Workspace label definitions
/api/v1/workspaces/{workspace_id}/label-definitionsReturns an ordered, cursor-bounded page of Workspace definitions. Continue with next_cursor using the same purpose and include_archived filters. Each page checks current Workspace authority and the commit-ordered Workspace journal version captured with the prior page. A change returns 409 catalog_changed; restart from page one. Native credentials require exactly one purpose=task query value. Other purposes are browser-only.
Path Parameters
Query Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Path Parameters
Header Parameters
Request Body
application/jsonResponses
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string·max 11Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
List a Project's local task-label definitions
/api/v1/projects/{project_id}/label-definitionsReturns an ordered, cursor-bounded page under current private Project read authority. Continue with next_cursor and the same include_archived filter. The cursor binds the prior page's commit-ordered Workspace journal version; a change returns 409 catalog_changed and requires a fresh first-page read.
Path Parameters
Query Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Path Parameters
Header Parameters
Request Body
application/jsonResponses
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string·max 11Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Read one authorized label definition
/api/v1/label-definitions/{label_id}Returns current or archived metadata in the active Workspace. Private Project access is required for Project-scoped definitions. Native credential admission is not included.
Path Parameters
Responses
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string·max 11Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Path Parameters
Header Parameters
Request Body
application/jsonstring·max 11Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
Responses
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string·max 11Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Path Parameters
Header Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
List a document, project, or task's label IDs
/api/v1/{target_kind}/{target_id}/labelsNative mobile credentials may read Task assignments only (target_kind=task).
Path Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Replace a document, project, or task's complete label assignment set
/api/v1/{target_kind}/{target_id}/labelsPath Parameters
Header Parameters
Request Body
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
List a Project's presentation overrides for Workspace Task labels
/api/v1/projects/{project_id}/label-overridesA sparse list: only Workspace Task labels with an active Project
override appear. A label with no entry here is shown with its
Workspace name and color in this Project.
Returns up to limit overrides in label ID order. Continue with
next_cursor while has_more is true. Cursors are signed and bound
to the current Workspace and Project. Restart from the first page
after a catalog change when a complete current view is required.
The cursor binds the prior page's commit-ordered Workspace journal
version. A change returns 409 catalog_changed before another page
can be applied.
Path Parameters
Query Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Set this Project's presentation of a Workspace Task label
/api/v1/projects/{project_id}/label-overrides/{label_id}Upserts the Project's own name and color for a Workspace-scope Task label. The label's stable identity and existing Task assignments are unaffected; only how it is displayed within this Project changes. Only a Workspace-scope Task label may be overridden.
Path Parameters
Header Parameters
Request Body
application/jsonResponses
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.
Restore the Workspace default presentation of a Task label in this Project
/api/v1/projects/{project_id}/label-overrides/{label_id}Path Parameters
Header Parameters
Responses
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.