On this page
taskLabel
query · in the family Task label
What it does
Look up one record — a label for organizing tasks.
A TaskLabel by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
What happens
Reads only — changes nothing.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:taskLabel
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
TaskLabel — A TaskLabel — the WORK vocabulary: a group-defined label attached to Tasks by reference (labelIds). DELIBERATELY its OWN master, NOT a reuse of the catalog Tag — catalog vocabulary (what we sell) and work vocabulary (how we operate) must not blend, and dooming a work label must never referential-gate against catalog nodes. The Tag SHAPE otherwise (caption + optional #rrggbb color; free-string labels stay unrepresentable — typo-proof, rename-safe via caption). FSM: active(i) ⇄ inactive → doomed (the template — ≠ the Tag's two-state: work vocabulary retires seasonally and comes back, so inactive earns its keep; 'blocked' lives HERE as a label because it has no machine consequence — the disclosed states-vs-labels lean). NOT searchable (supporting vocabulary — the Decoration SB-d class; reached via the tasks list filter, never name-found). The ops event domain (at.ops.task_label.*).
Example request
query ExampleTaskLabel($id: ID!) {
taskLabel(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
color
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"taskLabel": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "LB-EXMP-0000-000F",
"type": "TaskLabel",
"caption": "Blue jeans",
"status": "active",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"color": "<color>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)