{ "info": { "name": "Nifty v3 API (Public) 0.132.0", "description": "The Nifty v3 REST API. Everything below is a cross-cutting rule that holds on every\nendpoint; the per-endpoint pages describe only what is specific to them.\n\n## Authentication\n\nSend a personal access token (`nft_user_…`) or an OAuth 2.1 access token (`nft_oauth_…`) as a bearer token on every request. There is no other\nauthentication method, no API key query parameter and no cookie fallback. A missing or\nexpired token answers **401**; a valid token that lacks the scope an endpoint needs answers\n**403** — each endpoint lists its required scopes under Security. Tokens are workspace-scoped:\none token reaches exactly one workspace.\n\n```http\nAuthorization: Bearer $NIFTY_TOKEN\n```\n\n## Base URL and versions\n\nEvery endpoint lives under `https://openapi.niftypm.com/api/v3`. Paths shown in this reference are relative to that\nbase. New fields and new endpoints can appear within v3 without notice —\nignore response keys you do not recognise rather than rejecting them.\n\nSee the [Getting started guide](https://developers.niftypm.com/docs/getting-started) for a first request end to end.\n\n```bash\ncurl https://openapi.niftypm.com/api/v3/tasks \\\n -H \"Authorization: Bearer $NIFTY_TOKEN\"\n```\n\n## Renamed names\n\nSome names have changed, so that one concept has one name everywhere. This reference publishes\nonly the current spelling; the retired spelling keeps working, so nothing breaks on the day a\nname changes.\n\nA call that uses a retired ROUTE spelling is answered normally and additionally carries\n`Deprecation: true` and a `Link` header naming the route that replaces it. A retired FIELD name\nsent in a standard create or update body is accepted and applied to the current field. Both are\naccepted but not published: read the current names here, and treat the headers as your list of\nwhat to change.\n\nThe exception is an operation with a purpose-built body — the request shape published on that\nendpoint is validated exactly, so send the names it lists rather than the ones a general create\ntakes.\n\nThere is no `Sunset` header and no removal date. Retired names go away in a later release,\nannounced in the changelog before it ships; until then they keep working, and we would rather\ngive no date than one we later have to move.\n\n```http\nHTTP/1.1 200 OK\nDeprecation: true\nLink: <../check-ins>; rel=\"successor-version\",\n ; rel=\"deprecation\"\n```\n\n## Pagination\n\nEvery collection returns the same envelope: `data` (the page), `total`, `limit`, `hasMore` and\n`nextCursor`. Page forward by passing the previous `nextCursor` back as `?cursor=` until\n`hasMore` is false — never by counting rows. `limit` accepts 1–200 and defaults to 50; a larger\nvalue is silently clamped to 200 rather than rejected, so a short page never means the end.\n`total` is computed only when you ask for it with `?includeTotal=true`, because counting matching\nrows costs an extra query.\n\n```json\n{ \"data\": [], \"total\": 42, \"limit\": 50, \"hasMore\": true, \"nextCursor\": \"b2NjdXJyZWRBdD0y\" }\n```\n\n## Expanding objects\n\nRelated objects are returned as ids by default. Pass `?expand=` with a comma-separated list to\ninline them, using a dot for a nested hop; paths may be up to four hops deep. Each read endpoint\npublishes the relations it can resolve as an enum on its own `expand` parameter — a relation\noutside that list is refused with **400** `expand_unknown_relation`, whose `available` array names\nthe legal ones. Expansion is never automatic: omit the parameter and you get ids only.\n\n```http\nGET /tasks?expand=assignees,project.owner\n```\n\n## Idempotent requests\n\nAny mutating request may carry an `Idempotency-Key` header of up to 250 characters. A retry\nsending the same key replays the FIRST call’s stored response instead of performing the work a\nsecond time, so a client that times out can retry safely. The key is remembered for **10 minutes**\nand is bound to the request body: reusing it with a different body is refused with **422** rather\nthan silently replaying the wrong result. Generate a fresh key per distinct request.\n\n```http\nIdempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60\n```\n\n## Concurrency\n\nUpdates are last-writer-wins unless you say otherwise. To make an update conditional on the row\nnot having changed since you read it, send the `updatedAt` you read back as `expectedUpdatedAt` in\nthe request body. If another writer — a teammate, an agent or an automation — committed in the\nmeantime, the update is refused with **409** `stale_write`. Recover by re-reading the row,\nre-deriving your change from the current values, and retrying with the fresh `updatedAt`.\n\n```json\n{ \"name\": \"Ship the beta\", \"expectedUpdatedAt\": \"2026-05-31T12:00:00.000Z\" }\n```\n\n## Errors\n\nEvery failure returns the same RFC 7807 Problem Details body, served as `application/json`:\n`type`, `title`, `status` and `detail`, plus the Nifty extensions `code`, `requestId` and\n`docsUrl`. Branch on `code`, never on the wording of `detail`. A **400** from validation adds an\n`errors` array naming the offending fields. Quote `requestId` when you contact support — it\nidentifies the exact request in our logs.\n\nFull list with recovery steps: [Error reference](https://developers.niftypm.com/docs/errors).\n\n```json\n{ \"type\": \"resource_not_found\", \"title\": \"Resource not found\", \"status\": 404,\n \"detail\": \"task 'KfS0ha8P' not found or inaccessible\", \"code\": \"resource_not_found\",\n \"docsUrl\": \"https://developers.niftypm.com/docs/errors#resource_not_found\" }\n```\n\n## Rate limits\n\nLimits are per token and per HTTP method: 3,000 GETs per 5 minutes, 500 POSTs per minute,\n100 PATCHes per minute and 200 DELETEs per 10 minutes. Two buckets apply to each request, one\nkeyed by token and one by IP.\n\nBlock periods, and the status each limiter answers with: [Rate limits](https://developers.niftypm.com/docs/rate-limits).\n\n## Ids and timestamps\n\nResource ids are short opaque strings — treat them as text, never parse, pad or generate them,\nand never assume a length (today they run 8–17 characters, and that is not part of the contract).\nActor ids (`createdByActorId`, `updatedByActorId`) are UUIDs instead, because they identify a\nprincipal rather than a row, and the two id spaces are not interchangeable. Every timestamp is ISO\n8601 in UTC with millisecond precision, on both the way in and the way out. Fields ending in `Date`\nare calendar dates the workspace timezone applies to; fields ending in `At` are exact instants.\n\n```json\n{ \"id\": \"KfS0ha8P\", \"createdByActorId\": \"49f861f7-4af8-44bf-844f-45f85babe504\",\n \"createdAt\": \"2026-05-31T12:00:00.000Z\" }\n```\n\n## Soft delete and restore\n\nDELETE means two different things here, and each endpoint says which one it does. On a\nsoft-deleting resource the row moves to trash: it leaves list results at once, is purged\npermanently after a **30-day** retention window, and can be brought back before then with a\nrestore call such as `POST /documents/{id}/restore`. Everything else is destroyed immediately and\ncannot be recovered.\nRestoring something that is already active succeeds and changes nothing.\n\n```http\nPOST /tasks/KfS0ha8P/restore\n```\n\nSet the `niftyToken` variable to a Personal Access Token or an OAuth access token before sending a request. Request bodies are pre-filled with the REQUIRED fields only — see the reference for the optional ones.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{niftyToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://openapi.niftypm.com/api/v3", "type": "string" }, { "key": "niftyToken", "value": "", "type": "string" } ], "item": [ { "name": "Actor", "item": [ { "name": "List Actors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/actors", "host": [ "{{baseUrl}}" ], "path": [ "actors" ], "query": [ { "key": "sort", "value": "displayName", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `displayName`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "id[eq]", "value": "3f1a9c8e-5b2d-4e77-9a10-6c4de2f8b013", "description": "Filter where `id` equals.", "disabled": true }, { "key": "id[in]", "value": "3f1a9c8e-5b2d-4e77-9a10-6c4de2f8b013,3f1a9c8e-5b2d-4e77-9a10-6c4de2f8b013", "description": "Filter where `id` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "human", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "human,agent", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "memberId[eq]", "value": "P3hYIKqK", "description": "Filter where `memberId` equals.", "disabled": true }, { "key": "memberId[in]", "value": "P3hYIKqK,P3hYIKqK", "description": "Filter where `memberId` is one of (comma-separated list).", "disabled": true }, { "key": "agentId[eq]", "value": "8EO45hmm", "description": "Filter where `agentId` equals.", "disabled": true }, { "key": "agentId[in]", "value": "8EO45hmm,8EO45hmm", "description": "Filter where `agentId` is one of (comma-separated list).", "disabled": true } ] }, "description": "List actors. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `displayName` unless you pass `sort`.\n\n**Required scope:** `actors:read`" } }, { "name": "Get Actor", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/actors/:id", "host": [ "{{baseUrl}}" ], "path": [ "actors", ":id" ], "variable": [ { "key": "id", "value": "aheWuoWg", "description": "Id of the Actor." } ] }, "description": "Retrieve a single Actor by id.\n\n**Required scope:** `actors:read`" } } ] }, { "name": "Annotation", "item": [ { "name": "List Annotations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/annotations", "host": [ "{{baseUrl}}" ], "path": [ "annotations" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "file,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "fileId[eq]", "value": "xvM2toUM", "description": "Filter where `fileId` equals.", "disabled": true }, { "key": "fileId[in]", "value": "xvM2toUM,xvM2toUM", "description": "Filter where `fileId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "videoTimeSeconds[eq]", "value": "42.5", "description": "Filter where `videoTimeSeconds` equals.", "disabled": true }, { "key": "videoTimeSeconds[gt]", "value": "42.5", "description": "Filter where `videoTimeSeconds` is greater than.", "disabled": true }, { "key": "videoTimeSeconds[gte]", "value": "42.5", "description": "Filter where `videoTimeSeconds` is greater than or equal to.", "disabled": true }, { "key": "videoTimeSeconds[lt]", "value": "42.5", "description": "Filter where `videoTimeSeconds` is less than.", "disabled": true }, { "key": "videoTimeSeconds[lte]", "value": "42.5", "description": "Filter where `videoTimeSeconds` is less than or equal to.", "disabled": true }, { "key": "videoTimeSeconds[null]", "value": "true", "description": "Filter where `videoTimeSeconds` is null (pass `true`).", "disabled": true }, { "key": "videoTimeSeconds[notNull]", "value": "true", "description": "Filter where `videoTimeSeconds` is not null (pass `true`).", "disabled": true }, { "key": "type[eq]", "value": "image", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "image,video", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List annotations. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 6 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `annotations:read`" } }, { "name": "Create Annotation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"image\",\n \"fileId\": \"xvM2toUM\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/annotations", "host": [ "{{baseUrl}}" ], "path": [ "annotations" ], "query": [ { "key": "expand", "value": "file,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create an Annotation. Server-assigned fields are ignored if sent.\n\n**Required scope:** `annotations:write`" } }, { "name": "Get Annotation", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/annotations/:id", "host": [ "{{baseUrl}}" ], "path": [ "annotations", ":id" ], "query": [ { "key": "expand", "value": "file,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "863BiyIc", "description": "Id of the Annotation." } ] }, "description": "Retrieve a single Annotation by id.\n\n**Required scope:** `annotations:read`" } }, { "name": "Update Annotation", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/annotations/:id", "host": [ "{{baseUrl}}" ], "path": [ "annotations", ":id" ], "query": [ { "key": "expand", "value": "file,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "863BiyIc", "description": "Id of the Annotation." } ] }, "description": "Partially update an Annotation. Only the fields you send are changed.\n\n**Required scope:** `annotations:write`" } }, { "name": "Delete Annotation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/annotations/:id", "host": [ "{{baseUrl}}" ], "path": [ "annotations", ":id" ], "variable": [ { "key": "id", "value": "863BiyIc", "description": "Id of the Annotation." } ] }, "description": "Permanently delete this Annotation. This cannot be undone. The annotation's comment thread is deleted with it.\n\n**Required scope:** `annotations:delete`" } } ] }, { "name": "Chat", "item": [ { "name": "List Chats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/chats", "host": [ "{{baseUrl}}" ], "path": [ "chats" ], "query": [ { "key": "sort", "value": "lastMessageAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `lastMessageAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "members,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "type[eq]", "value": "group", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "group,direct", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "lastMessageAt[gt]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is greater than.", "disabled": true }, { "key": "lastMessageAt[gte]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is greater than or equal to.", "disabled": true }, { "key": "lastMessageAt[lt]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is less than.", "disabled": true }, { "key": "lastMessageAt[lte]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "recipientMemberId[eq]", "value": "AdeWqOs6", "description": "Filter where `recipientMemberId` equals.", "disabled": true } ] }, "description": "List chats. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 5 fields. Ordered by `lastMessageAt` unless you pass `sort`.\n\n**Required scope:** `chats:read`" } }, { "name": "Create Chat", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chats", "host": [ "{{baseUrl}}" ], "path": [ "chats" ], "query": [ { "key": "expand", "value": "members,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Chat. Server-assigned fields are ignored if sent.\n\n**Required scope:** `chats:write`" } }, { "name": "Get Chat", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/chats/:id", "host": [ "{{baseUrl}}" ], "path": [ "chats", ":id" ], "query": [ { "key": "expand", "value": "members,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "hTIeouEK", "description": "Id of the Chat." } ] }, "description": "Retrieve a single Chat by id.\n\n**Required scope:** `chats:read`" } }, { "name": "Update Chat", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/chats/:id", "host": [ "{{baseUrl}}" ], "path": [ "chats", ":id" ], "query": [ { "key": "expand", "value": "members,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "hTIeouEK", "description": "Id of the Chat." } ] }, "description": "Partially update a Chat. Only the fields you send are changed.\n\n**Required scope:** `chats:write`" } }, { "name": "Delete Chat", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/chats/:id", "host": [ "{{baseUrl}}" ], "path": [ "chats", ":id" ], "variable": [ { "key": "id", "value": "hTIeouEK", "description": "Id of the Chat." } ] }, "description": "Permanently delete this Chat. This cannot be undone. Every message in the chat is deleted with it.\n\n**Required scope:** `chats:delete`" } }, { "name": "Search Chats", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/chats/search", "host": [ "{{baseUrl}}" ], "path": [ "chats", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "members,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "type[eq]", "value": "group", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "group,direct", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "lastMessageAt[gt]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is greater than.", "disabled": true }, { "key": "lastMessageAt[gte]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is greater than or equal to.", "disabled": true }, { "key": "lastMessageAt[lt]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is less than.", "disabled": true }, { "key": "lastMessageAt[lte]", "value": "2026-06-02T18:00:00.000Z", "description": "Filter where `lastMessageAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "recipientMemberId[eq]", "value": "AdeWqOs6", "description": "Filter where `recipientMemberId` equals.", "disabled": true } ] }, "description": "Full-text ranked search across chats. Ranked by relevance; pages are capped at 200 results. Filterable by 5 fields.\n\n**Required scope:** `chats:read`" } } ] }, { "name": "Check-in", "item": [ { "name": "List Check-ins", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/check-ins", "host": [ "{{baseUrl}}" ], "path": [ "check-ins" ], "query": [ { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "form,recurringRule", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "requestType[eq]", "value": "schedule", "description": "Filter where `requestType` equals.", "disabled": true }, { "key": "requestType[in]", "value": "schedule,manual", "description": "Filter where `requestType` is one of (comma-separated list).", "disabled": true }, { "key": "formId[eq]", "value": "Jt0ByAIi", "description": "Filter where `formId` equals.", "disabled": true }, { "key": "formId[in]", "value": "Jt0ByAIi,Jt0ByAIi", "description": "Filter where `formId` is one of (comma-separated list).", "disabled": true }, { "key": "recurringRuleId[eq]", "value": "cn2v0xiQ", "description": "Filter where `recurringRuleId` equals.", "disabled": true }, { "key": "recurringRuleId[in]", "value": "cn2v0xiQ,cn2v0xiQ", "description": "Filter where `recurringRuleId` is one of (comma-separated list).", "disabled": true }, { "key": "createdByActorId[eq]", "value": "49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` equals.", "disabled": true }, { "key": "createdByActorId[in]", "value": "49f861f7-4af8-44bf-844f-45f85babe504,49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List checkIns. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 7 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `check-ins:read`" } }, { "name": "Create Check-in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"notifyTypes\": [\n \"email\"\n ],\n \"requestType\": \"schedule\",\n \"formId\": \"Jt0ByAIi\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins", "host": [ "{{baseUrl}}" ], "path": [ "check-ins" ], "query": [ { "key": "expand", "value": "form,recurringRule", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Check-in. Server-assigned fields are ignored if sent.\n\n**Required scope:** `check-ins:write`" } }, { "name": "Get Check-in", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/check-ins/:id", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id" ], "query": [ { "key": "expand", "value": "form,recurringRule", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Retrieve a single Check-in by id.\n\n**Required scope:** `check-ins:read`" } }, { "name": "Update Check-in", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins/:id", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id" ], "query": [ { "key": "expand", "value": "form,recurringRule", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Partially update a Check-in. Only the fields you send are changed.\n\n**Required scope:** `check-ins:write`" } }, { "name": "Delete Check-in", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/check-ins/:id", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id" ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Permanently delete this Check-in. This cannot be undone.\n\n**Required scope:** `check-ins:delete`" } }, { "name": "Search Check-ins", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/check-ins/search", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "form,recurringRule", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "requestType[eq]", "value": "schedule", "description": "Filter where `requestType` equals.", "disabled": true }, { "key": "requestType[in]", "value": "schedule,manual", "description": "Filter where `requestType` is one of (comma-separated list).", "disabled": true }, { "key": "formId[eq]", "value": "Jt0ByAIi", "description": "Filter where `formId` equals.", "disabled": true }, { "key": "formId[in]", "value": "Jt0ByAIi,Jt0ByAIi", "description": "Filter where `formId` is one of (comma-separated list).", "disabled": true }, { "key": "recurringRuleId[eq]", "value": "cn2v0xiQ", "description": "Filter where `recurringRuleId` equals.", "disabled": true }, { "key": "recurringRuleId[in]", "value": "cn2v0xiQ,cn2v0xiQ", "description": "Filter where `recurringRuleId` is one of (comma-separated list).", "disabled": true }, { "key": "createdByActorId[eq]", "value": "49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` equals.", "disabled": true }, { "key": "createdByActorId[in]", "value": "49f861f7-4af8-44bf-844f-45f85babe504,49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across checkIns. Ranked by relevance; pages are capped at 200 results. Filterable by 7 fields.\n\n**Required scope:** `check-ins:read`" } }, { "name": "Add assignees to a Check-in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins/:id/assignees", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id", "assignees" ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Link the given ids to this Check-in as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `check-ins:write` `check-ins:link`" } }, { "name": "Remove assignees from a Check-in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins/:id/assignees/remove", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id", "assignees", "remove" ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Unlink the given ids from this Check-in's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `check-ins:write` `check-ins:link`" } }, { "name": "Add subscribers to a Check-in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins/:id/subscribers", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id", "subscribers" ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Link the given ids to this Check-in as subscribers. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `check-ins:write` `check-ins:link`" } }, { "name": "Remove subscribers from a Check-in", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-ins/:id/subscribers/remove", "host": [ "{{baseUrl}}" ], "path": [ "check-ins", ":id", "subscribers", "remove" ], "variable": [ { "key": "id", "value": "8cQSsSK8", "description": "Id of the Check-in." } ] }, "description": "Unlink the given ids from this Check-in's subscribers. Removing one that is not linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `check-ins:write` `check-ins:link`" } } ] }, { "name": "Check-in request", "item": [ { "name": "List Check-in requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/check-in-requests", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests" ], "query": [ { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "checkIn,assignees", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "checkInId[eq]", "value": "8cQSsSK8", "description": "Filter where `checkInId` equals.", "disabled": true }, { "key": "checkInId[in]", "value": "8cQSsSK8,8cQSsSK8", "description": "Filter where `checkInId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true }, { "key": "reminderSentAt[gt]", "value": "2026-06-08T09:00:00.000Z", "description": "Filter where `reminderSentAt` is greater than.", "disabled": true }, { "key": "reminderSentAt[gte]", "value": "2026-06-08T09:00:00.000Z", "description": "Filter where `reminderSentAt` is greater than or equal to.", "disabled": true }, { "key": "reminderSentAt[lt]", "value": "2026-06-08T09:00:00.000Z", "description": "Filter where `reminderSentAt` is less than.", "disabled": true }, { "key": "reminderSentAt[lte]", "value": "2026-06-08T09:00:00.000Z", "description": "Filter where `reminderSentAt` is less than or equal to.", "disabled": true } ] }, "description": "List checkInRequests. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `check-in-requests:read`" } }, { "name": "Create Check-in request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"checkInId\": \"8cQSsSK8\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-in-requests", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests" ], "query": [ { "key": "expand", "value": "checkIn,assignees", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Check-in request. Server-assigned fields are ignored if sent.\n\n**Required scope:** `check-in-requests:write`" } }, { "name": "Get Check-in request", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/check-in-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests", ":id" ], "query": [ { "key": "expand", "value": "checkIn,assignees", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "fVCU89x0", "description": "Id of the Check-in request." } ] }, "description": "Retrieve a single Check-in request by id.\n\n**Required scope:** `check-in-requests:read`" } }, { "name": "Delete Check-in request", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/check-in-requests/:id", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests", ":id" ], "variable": [ { "key": "id", "value": "fVCU89x0", "description": "Id of the Check-in request." } ] }, "description": "Permanently delete this Check-in request. This cannot be undone.\n\n**Required scope:** `check-in-requests:delete`" } }, { "name": "Add assignees to a Check-in request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-in-requests/:id/assignees", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests", ":id", "assignees" ], "variable": [ { "key": "id", "value": "fVCU89x0", "description": "Id of the Check-in request." } ] }, "description": "Link the given ids to this Check-in request as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `check-in-requests:write` `check-in-requests:link`" } }, { "name": "Remove assignees from a Check-in request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/check-in-requests/:id/assignees/remove", "host": [ "{{baseUrl}}" ], "path": [ "check-in-requests", ":id", "assignees", "remove" ], "variable": [ { "key": "id", "value": "fVCU89x0", "description": "Id of the Check-in request." } ] }, "description": "Unlink the given ids from this Check-in request's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `check-in-requests:write` `check-in-requests:link`" } } ] }, { "name": "Checklist", "item": [ { "name": "List Checklists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/checklists", "host": [ "{{baseUrl}}" ], "path": [ "checklists" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list checklists across every project you can access.", "disabled": true }, { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "task,checklistItems", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List checklists. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `checklists:read`" } }, { "name": "Create Checklist", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"taskId\": \"KfS0ha8P\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checklists", "host": [ "{{baseUrl}}" ], "path": [ "checklists" ], "query": [ { "key": "expand", "value": "task,checklistItems", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Checklist. Server-assigned fields are ignored if sent.\n\n**Required scope:** `checklists:write`" } }, { "name": "Get Checklist", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/checklists/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklists", ":id" ], "query": [ { "key": "expand", "value": "task,checklistItems", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "NrmgIiU8", "description": "Id of the Checklist." } ] }, "description": "Retrieve a single Checklist by id.\n\n**Required scope:** `checklists:read`" } }, { "name": "Update Checklist", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checklists/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklists", ":id" ], "query": [ { "key": "expand", "value": "task,checklistItems", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "NrmgIiU8", "description": "Id of the Checklist." } ] }, "description": "Partially update a Checklist. Only the fields you send are changed.\n\n**Required scope:** `checklists:write`" } }, { "name": "Delete Checklist", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/checklists/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklists", ":id" ], "variable": [ { "key": "id", "value": "NrmgIiU8", "description": "Id of the Checklist." } ] }, "description": "Permanently delete this Checklist. This cannot be undone.\n\n**Required scope:** `checklists:delete`" } } ] }, { "name": "Checklist Item", "item": [ { "name": "List Checklist Items", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/checklist-items", "host": [ "{{baseUrl}}" ], "path": [ "checklist-items" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list checklistItems across every project you can access.", "disabled": true }, { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "checklist,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "checklistId[eq]", "value": "NrmgIiU8", "description": "Filter where `checklistId` equals.", "disabled": true }, { "key": "checklistId[in]", "value": "NrmgIiU8,NrmgIiU8", "description": "Filter where `checklistId` is one of (comma-separated list).", "disabled": true }, { "key": "completed[eq]", "value": "false", "description": "Filter where `completed` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List checklistItems. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `checklist-items:read`" } }, { "name": "Create Checklist Item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"checklistId\": \"NrmgIiU8\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checklist-items", "host": [ "{{baseUrl}}" ], "path": [ "checklist-items" ], "query": [ { "key": "expand", "value": "checklist,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Checklist Item. Server-assigned fields are ignored if sent.\n\n**Required scope:** `checklist-items:write`" } }, { "name": "Get Checklist Item", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/checklist-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklist-items", ":id" ], "query": [ { "key": "expand", "value": "checklist,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "iLCQkeWQ", "description": "Id of the Checklist Item." } ] }, "description": "Retrieve a single Checklist Item by id.\n\n**Required scope:** `checklist-items:read`" } }, { "name": "Update Checklist Item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/checklist-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklist-items", ":id" ], "query": [ { "key": "expand", "value": "checklist,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "iLCQkeWQ", "description": "Id of the Checklist Item." } ] }, "description": "Partially update a Checklist Item. Only the fields you send are changed.\n\n**Required scope:** `checklist-items:write`" } }, { "name": "Delete Checklist Item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/checklist-items/:id", "host": [ "{{baseUrl}}" ], "path": [ "checklist-items", ":id" ], "variable": [ { "key": "id", "value": "iLCQkeWQ", "description": "Id of the Checklist Item." } ] }, "description": "Permanently delete this Checklist Item. This cannot be undone.\n\n**Required scope:** `checklist-items:delete`" } } ] }, { "name": "Custom Field", "item": [ { "name": "List Custom Fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/custom-fields", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields" ], "query": [ { "key": "sort", "value": "name", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `name`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "options,hiddenFor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "type[eq]", "value": "dropdown", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "dropdown,text", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "inLibrary[eq]", "value": "false", "description": "Filter where `inLibrary` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List customFields. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `name` unless you pass `sort`.\n\n**Required scope:** `custom-fields:read`" } }, { "name": "Get Custom Field", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/custom-fields/:id", "host": [ "{{baseUrl}}" ], "path": [ "custom-fields", ":id" ], "query": [ { "key": "expand", "value": "options,hiddenFor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "6GWCcskG", "description": "Id of the Custom Field." } ] }, "description": "Retrieve a single Custom Field by id.\n\n**Required scope:** `custom-fields:read`" } } ] }, { "name": "Document", "item": [ { "name": "List Documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list documents across every project you can access.", "disabled": true }, { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,author", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "parentDocumentId[eq]", "value": "429XYeO6", "description": "Filter where `parentDocumentId` equals.", "disabled": true }, { "key": "parentDocumentId[in]", "value": "429XYeO6,429XYeO6", "description": "Filter where `parentDocumentId` is one of (comma-separated list).", "disabled": true }, { "key": "parentDocumentId[null]", "value": "true", "description": "Filter where `parentDocumentId` is null (pass `true`).", "disabled": true }, { "key": "parentDocumentId[notNull]", "value": "true", "description": "Filter where `parentDocumentId` is not null (pass `true`).", "disabled": true }, { "key": "type[eq]", "value": "nifty", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "nifty,google", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "editorVersion[eq]", "value": "2", "description": "Filter where `editorVersion` equals.", "disabled": true }, { "key": "editorVersion[in]", "value": "2,2", "description": "Filter where `editorVersion` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List documents. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 9 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `documents:read`" } }, { "name": "Create Document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"projectId\": \"iV6vIU8N\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents", "host": [ "{{baseUrl}}" ], "path": [ "documents" ], "query": [ { "key": "expand", "value": "project,author", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Document. Server-assigned fields are ignored if sent.\n\n**Required scope:** `documents:write`" } }, { "name": "Get Document", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "query": [ { "key": "expand", "value": "project,author", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Retrieve a single Document by id.\n\n**Required scope:** `documents:read`" } }, { "name": "Update Document", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "query": [ { "key": "expand", "value": "project,author", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Partially update a Document. Only the fields you send are changed.\n\n**Required scope:** `documents:write`" } }, { "name": "Delete Document", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/documents/:id", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Move this Document to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `documents:delete`" } }, { "name": "Search Documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/documents/search", "host": [ "{{baseUrl}}" ], "path": [ "documents", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "projectId", "value": "iV6vIU8N", "description": "The project to search within. Required — documents are project-scoped and search has no workspace-wide mode.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,author", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "parentDocumentId[eq]", "value": "429XYeO6", "description": "Filter where `parentDocumentId` equals.", "disabled": true }, { "key": "parentDocumentId[in]", "value": "429XYeO6,429XYeO6", "description": "Filter where `parentDocumentId` is one of (comma-separated list).", "disabled": true }, { "key": "parentDocumentId[null]", "value": "true", "description": "Filter where `parentDocumentId` is null (pass `true`).", "disabled": true }, { "key": "parentDocumentId[notNull]", "value": "true", "description": "Filter where `parentDocumentId` is not null (pass `true`).", "disabled": true }, { "key": "type[eq]", "value": "nifty", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "nifty,google", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "editorVersion[eq]", "value": "2", "description": "Filter where `editorVersion` equals.", "disabled": true }, { "key": "editorVersion[in]", "value": "2,2", "description": "Filter where `editorVersion` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across documents. Ranked by relevance; pages are capped at 200 results. Filterable by 9 fields.\n\n**Required scope:** `documents:read`" } }, { "name": "Add labels to a Document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "labels" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Link the given ids to this Document as labels. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `documents:write` `documents:link`" } }, { "name": "Remove labels from a Document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/labels/remove", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "labels", "remove" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Unlink the given ids from this Document's labels. Removing one that is not linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `documents:write` `documents:link`" } }, { "name": "Content (Document)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/documents/:id/content", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "content" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Read a document body as Markdown — the rich-text content, which list and get do not return. Returns { format, content, truncated, byteSize, lossy }; a large body is truncated with truncated=true, and lossy=true means some formatting was dropped in the Markdown conversion.\n\n**Required scope:** `documents:read`" } }, { "name": "Append (Document)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"content\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/append", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "append" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Append Markdown to the END of a document's body. This is the only way to add to an existing document's content — `update` cannot change the body, and there is no way to replace or delete existing content. Use `content` (the read operation) first if you need to know what the document already says. Appends are additive and never overwrite what is there, including what someone else is typing right now.\n\n**Required scope:** `documents:write`" } }, { "name": "Edit text (Document)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"find\": \"\",\n \"replace\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/documents/:id/edit-text", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "edit-text" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Replace exact text within a document's body — the way to EDIT existing content, as opposed to `append` (which only adds to the end) or `update` (which cannot touch the body at all). Use `content` (the read operation) first to see the exact text to match. By default only the FIRST match of `find` is replaced; use `occurrence` to target the Nth match, `anchorBefore`/`anchorAfter` to disambiguate by surrounding text when `find` is not unique, or `replaceAll` to replace every match. Fails with a teaching error if `find` cannot be located or is ambiguous, rather than guessing. `replace` is inserted as plain text (no Markdown is parsed) and inherits the matched text's formatting.\n\n**Required scope:** `documents:write`" } }, { "name": "Restore Document", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/documents/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "documents", ":id", "restore" ], "variable": [ { "key": "id", "value": "ELe0nkum", "description": "Id of the Document." } ] }, "description": "Restore a Document that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `documents:delete`" } } ] }, { "name": "Favorite", "item": [ { "name": "List Favorites", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorites", "host": [ "{{baseUrl}}" ], "path": [ "favorites" ], "query": [ { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "member,favoriteFolder", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "type[eq]", "value": "project", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "project,document", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "favoriteFolderId[eq]", "value": "HXamuWk4", "description": "Filter where `favoriteFolderId` equals.", "disabled": true }, { "key": "favoriteFolderId[in]", "value": "HXamuWk4,HXamuWk4", "description": "Filter where `favoriteFolderId` is one of (comma-separated list).", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true } ] }, "description": "List favorites. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `favorites:read`" } }, { "name": "Create Favorite", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"type\": \"project\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/favorites", "host": [ "{{baseUrl}}" ], "path": [ "favorites" ], "query": [ { "key": "expand", "value": "member,favoriteFolder", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Favorite. Server-assigned fields are ignored if sent.\n\n**Required scope:** `favorites:write`" } }, { "name": "Get Favorite", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorites/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorites", ":id" ], "query": [ { "key": "expand", "value": "member,favoriteFolder", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "pzw41NKo", "description": "Id of the Favorite." } ] }, "description": "Retrieve a single Favorite by id.\n\n**Required scope:** `favorites:read`" } }, { "name": "Update Favorite", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/favorites/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorites", ":id" ], "query": [ { "key": "expand", "value": "member,favoriteFolder", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "pzw41NKo", "description": "Id of the Favorite." } ] }, "description": "Partially update a Favorite. Only the fields you send are changed.\n\n**Required scope:** `favorites:write`" } }, { "name": "Delete Favorite", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/favorites/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorites", ":id" ], "variable": [ { "key": "id", "value": "pzw41NKo", "description": "Id of the Favorite." } ] }, "description": "Permanently delete this Favorite. This cannot be undone.\n\n**Required scope:** `favorites:delete`" } }, { "name": "Search Favorites", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorites/search", "host": [ "{{baseUrl}}" ], "path": [ "favorites", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "member,favoriteFolder", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "type[eq]", "value": "project", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "project,document", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "favoriteFolderId[eq]", "value": "HXamuWk4", "description": "Filter where `favoriteFolderId` equals.", "disabled": true }, { "key": "favoriteFolderId[in]", "value": "HXamuWk4,HXamuWk4", "description": "Filter where `favoriteFolderId` is one of (comma-separated list).", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true } ] }, "description": "Full-text ranked search across favorites. Ranked by relevance; pages are capped at 200 results. Filterable by 4 fields.\n\n**Required scope:** `favorites:read`" } } ] }, { "name": "Favorite Folder", "item": [ { "name": "List Favorite Folders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorite-folders", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders" ], "query": [ { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdBy,updatedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List favoriteFolders. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 2 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `favorite-folders:read`" } }, { "name": "Create Favorite Folder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/favorite-folders", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders" ], "query": [ { "key": "expand", "value": "createdBy,updatedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Favorite Folder. Server-assigned fields are ignored if sent.\n\n**Required scope:** `favorite-folders:write`" } }, { "name": "Get Favorite Folder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorite-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders", ":id" ], "query": [ { "key": "expand", "value": "createdBy,updatedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "HXamuWk4", "description": "Id of the Favorite Folder." } ] }, "description": "Retrieve a single Favorite Folder by id.\n\n**Required scope:** `favorite-folders:read`" } }, { "name": "Update Favorite Folder", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/favorite-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders", ":id" ], "query": [ { "key": "expand", "value": "createdBy,updatedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "HXamuWk4", "description": "Id of the Favorite Folder." } ] }, "description": "Partially update a Favorite Folder. Only the fields you send are changed.\n\n**Required scope:** `favorite-folders:write`" } }, { "name": "Delete Favorite Folder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/favorite-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders", ":id" ], "variable": [ { "key": "id", "value": "HXamuWk4", "description": "Id of the Favorite Folder." } ] }, "description": "Permanently delete this Favorite Folder. This cannot be undone.\n\n**Required scope:** `favorite-folders:delete`" } }, { "name": "Search Favorite Folders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/favorite-folders/search", "host": [ "{{baseUrl}}" ], "path": [ "favorite-folders", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdBy,updatedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across favoriteFolders. Ranked by relevance; pages are capped at 200 results. Filterable by 2 fields.\n\n**Required scope:** `favorite-folders:read`" } } ] }, { "name": "File", "item": [ { "name": "List Files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "uploader,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "documentId[eq]", "value": "ELe0nkum", "description": "Filter where `documentId` equals.", "disabled": true }, { "key": "documentId[in]", "value": "ELe0nkum,ELe0nkum", "description": "Filter where `documentId` is one of (comma-separated list).", "disabled": true }, { "key": "messageId[eq]", "value": "4SsY67bC", "description": "Filter where `messageId` equals.", "disabled": true }, { "key": "messageId[in]", "value": "4SsY67bC,4SsY67bC", "description": "Filter where `messageId` is one of (comma-separated list).", "disabled": true }, { "key": "folderId[eq]", "value": "dBGa8nam", "description": "Filter where `folderId` equals.", "disabled": true }, { "key": "folderId[in]", "value": "dBGa8nam,dBGa8nam", "description": "Filter where `folderId` is one of (comma-separated list).", "disabled": true }, { "key": "annotationTaskId[eq]", "value": "fV4pUGI6", "description": "Filter where `annotationTaskId` equals.", "disabled": true }, { "key": "annotationTaskId[in]", "value": "fV4pUGI6,fV4pUGI6", "description": "Filter where `annotationTaskId` is one of (comma-separated list).", "disabled": true }, { "key": "uploaderId[eq]", "value": "FL6HICQe", "description": "Filter where `uploaderId` equals.", "disabled": true }, { "key": "uploaderId[in]", "value": "FL6HICQe,FL6HICQe", "description": "Filter where `uploaderId` is one of (comma-separated list).", "disabled": true }, { "key": "processed[eq]", "value": "false", "description": "Filter where `processed` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List files. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 12 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `files:read`" } }, { "name": "Create File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"size\": 20480,\n \"uploadKey\": \"Example upload key\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files", "host": [ "{{baseUrl}}" ], "path": [ "files" ], "query": [ { "key": "expand", "value": "uploader,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a File. Server-assigned fields are ignored if sent. This REGISTERS METADATA — it does not upload bytes. Get the bytes into storage first with the createUploadUrl operation (which returns an `uploadKey` plus a presigned URL to PUT to), then create the file passing that `uploadKey`, the `name` and the `size` in bytes. createFromContent and uploadFromUrl do both halves in one call. AT LEAST ONE parent is required: `projectId`, `taskId`, `documentId`, `messageId` or `folderId` — a create with none of them is rejected. A file is capped at 2 GB, and each team has a total storage quota; exceeding either is rejected.\n\n**Required scope:** `files:write`" } }, { "name": "Get File", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id" ], "query": [ { "key": "expand", "value": "uploader,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Retrieve a single File by id.\n\n**Required scope:** `files:read`" } }, { "name": "Update File", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id" ], "query": [ { "key": "expand", "value": "uploader,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Partially update a File. Only the fields you send are changed.\n\n**Required scope:** `files:write`" } }, { "name": "Delete File", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/files/:id", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Move this File to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `files:delete`" } }, { "name": "Search Files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/files/search", "host": [ "{{baseUrl}}" ], "path": [ "files", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "uploader,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "documentId[eq]", "value": "ELe0nkum", "description": "Filter where `documentId` equals.", "disabled": true }, { "key": "documentId[in]", "value": "ELe0nkum,ELe0nkum", "description": "Filter where `documentId` is one of (comma-separated list).", "disabled": true }, { "key": "messageId[eq]", "value": "4SsY67bC", "description": "Filter where `messageId` equals.", "disabled": true }, { "key": "messageId[in]", "value": "4SsY67bC,4SsY67bC", "description": "Filter where `messageId` is one of (comma-separated list).", "disabled": true }, { "key": "folderId[eq]", "value": "dBGa8nam", "description": "Filter where `folderId` equals.", "disabled": true }, { "key": "folderId[in]", "value": "dBGa8nam,dBGa8nam", "description": "Filter where `folderId` is one of (comma-separated list).", "disabled": true }, { "key": "annotationTaskId[eq]", "value": "fV4pUGI6", "description": "Filter where `annotationTaskId` equals.", "disabled": true }, { "key": "annotationTaskId[in]", "value": "fV4pUGI6,fV4pUGI6", "description": "Filter where `annotationTaskId` is one of (comma-separated list).", "disabled": true }, { "key": "uploaderId[eq]", "value": "FL6HICQe", "description": "Filter where `uploaderId` equals.", "disabled": true }, { "key": "uploaderId[in]", "value": "FL6HICQe,FL6HICQe", "description": "Filter where `uploaderId` is one of (comma-separated list).", "disabled": true }, { "key": "processed[eq]", "value": "false", "description": "Filter where `processed` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across files. Ranked by relevance; pages are capped at 200 results. Filterable by 12 fields.\n\n**Required scope:** `files:read`" } }, { "name": "Add subscribers to a File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:id/subscribers", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id", "subscribers" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Link the given ids to this File as subscribers. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `files:write` `files:link`" } }, { "name": "Remove subscribers from a File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:id/subscribers/remove", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id", "subscribers", "remove" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Unlink the given ids from this File's subscribers. Removing one that is not linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `files:write` `files:link`" } }, { "name": "Add labels to a File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id", "labels" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Link the given ids to this File as labels. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `files:write` `files:link`" } }, { "name": "Remove labels from a File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/:id/labels/remove", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id", "labels", "remove" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Unlink the given ids from this File's labels. Removing one that is not linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `files:write` `files:link`" } }, { "name": "Create upload url (File)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/create-upload-url", "host": [ "{{baseUrl}}" ], "path": [ "files", "create-upload-url" ] }, "description": "Mint a presigned S3 upload URL — step 1 of uploading a new file. Step 2: HTTP PUT the raw bytes to `uploadUrl` sending exactly `headers`. Step 3: create the file with `POST /files`, passing the returned `uploadKey`, plus name, size (byte count of what you uploaded), and exactly ONE parent — projectId, taskId, documentId or messageId. uploadUrl expires (~15 min); max 2 GB. If your client cannot make raw HTTP PUTs (sandboxed environments), use createFromContent instead (max 3 MB). To attach an asset you only have a URL for, use uploadFromUrl instead (max 25 MB).\n\n**Required scope:** `files:write`" } }, { "name": "Create from content (File)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"contentBase64\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/create-from-content", "host": [ "{{baseUrl}}" ], "path": [ "files", "create-from-content" ] }, "description": "Create a file from inline base64 content in ONE call — for clients that cannot HTTP PUT raw bytes to S3 (sandboxed/egress-blocked environments); max 3 MB decoded. Prefer createUploadUrl + HTTP PUT when your environment has open egress — base64 costs ~1.37x the bytes and transits your context. `name` needs the file extension. Pass at least one parent — taskId, projectId, documentId, messageId or folderId; with only taskId the server derives the project from the task. If you only have a URL to the asset, use uploadFromUrl.\n\n**Required scope:** `files:write`" } }, { "name": "Upload from url (File)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"sourceUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/files/upload-from-url", "host": [ "{{baseUrl}}" ], "path": [ "files", "upload-from-url" ] }, "description": "Create a file from a public http/https URL in ONE call — the SERVER fetches it, for a client that has the address but cannot fetch the bytes (egress-blocked/sandboxed environments); the URL goes in `sourceUrl` (not `uploadKey`, which on file create is the pointer to already-uploaded bytes, and not `url`, which is the download link on a stored file), max 25 MB, and at least one parent is required (taskId, projectId, documentId, messageId or folderId). Up to 3 redirects; private/internal addresses are refused. `name` defaults to the URL's filename. With only taskId the server derives projectId. If you HAVE the bytes and they are ≤3 MB use createFromContent; for big files with open egress use createUploadUrl + HTTP PUT.\n\n**Required scope:** `files:write`" } }, { "name": "Restore File", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/files/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "files", ":id", "restore" ], "variable": [ { "key": "id", "value": "xvM2toUM", "description": "Id of the File." } ] }, "description": "Restore a File that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `files:delete`" } } ] }, { "name": "Form", "item": [ { "name": "List Forms", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/forms", "host": [ "{{baseUrl}}" ], "path": [ "forms" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "automation[eq]", "value": "task", "description": "Filter where `automation` equals.", "disabled": true }, { "key": "automation[in]", "value": "task,doc", "description": "Filter where `automation` is one of (comma-separated list).", "disabled": true }, { "key": "docAccessType[eq]", "value": "public", "description": "Filter where `docAccessType` equals.", "disabled": true }, { "key": "docAccessType[in]", "value": "public,limited", "description": "Filter where `docAccessType` is one of (comma-separated list).", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "createdById[eq]", "value": "Qf8HggwY", "description": "Filter where `createdById` equals.", "disabled": true }, { "key": "createdById[in]", "value": "Qf8HggwY,Qf8HggwY", "description": "Filter where `createdById` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List forms. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 6 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `forms:read`" } }, { "name": "Get Form", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/forms/:id", "host": [ "{{baseUrl}}" ], "path": [ "forms", ":id" ], "query": [ { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "Jt0ByAIi", "description": "Id of the Form." } ] }, "description": "Retrieve a single Form by id.\n\n**Required scope:** `forms:read`" } }, { "name": "Restore Form", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/forms/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "forms", ":id", "restore" ], "variable": [ { "key": "id", "value": "Jt0ByAIi", "description": "Id of the Form." } ] }, "description": "Restore a Form that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `forms:delete`" } } ] }, { "name": "Goal", "item": [ { "name": "List Goals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goals", "host": [ "{{baseUrl}}" ], "path": [ "goals" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "owner,goalGroup", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "goalGroupId[eq]", "value": "pPAcKseY", "description": "Filter where `goalGroupId` equals.", "disabled": true }, { "key": "goalGroupId[in]", "value": "pPAcKseY,pPAcKseY", "description": "Filter where `goalGroupId` is one of (comma-separated list).", "disabled": true }, { "key": "ownerId[eq]", "value": "QpCuKyI2", "description": "Filter where `ownerId` equals.", "disabled": true }, { "key": "ownerId[in]", "value": "QpCuKyI2,QpCuKyI2", "description": "Filter where `ownerId` is one of (comma-separated list).", "disabled": true }, { "key": "endAt[eq]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` equals.", "disabled": true }, { "key": "endAt[gt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is greater than.", "disabled": true }, { "key": "endAt[gte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is greater than or equal to.", "disabled": true }, { "key": "endAt[lt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is less than.", "disabled": true }, { "key": "endAt[lte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List goals. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 6 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `goals:read`" } }, { "name": "Create Goal", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"endAt\": \"2026-06-14T12:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/goals", "host": [ "{{baseUrl}}" ], "path": [ "goals" ], "query": [ { "key": "expand", "value": "owner,goalGroup", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Goal. Server-assigned fields are ignored if sent. Requires a human-backed identity — a user session or a personal access token. Application and agent tokens receive 403 here; they can read goals but not change them.\n\n**Required scope:** `goals:write`" } }, { "name": "Get Goal", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goals/:id", "host": [ "{{baseUrl}}" ], "path": [ "goals", ":id" ], "query": [ { "key": "expand", "value": "owner,goalGroup", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "AdESgais", "description": "Id of the Goal." } ] }, "description": "Retrieve a single Goal by id.\n\n**Required scope:** `goals:read`" } }, { "name": "Update Goal", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/goals/:id", "host": [ "{{baseUrl}}" ], "path": [ "goals", ":id" ], "query": [ { "key": "expand", "value": "owner,goalGroup", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "AdESgais", "description": "Id of the Goal." } ] }, "description": "Partially update a Goal. Only the fields you send are changed. Requires a human-backed identity — a user session or a personal access token. Application and agent tokens receive 403 here; they can read goals but not change them.\n\n**Required scope:** `goals:write`" } }, { "name": "Delete Goal", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/goals/:id", "host": [ "{{baseUrl}}" ], "path": [ "goals", ":id" ], "variable": [ { "key": "id", "value": "AdESgais", "description": "Id of the Goal." } ] }, "description": "Permanently delete this Goal. This cannot be undone. Requires a human-backed identity — a user session or a personal access token. Application and agent tokens receive 403 here; they can read goals but not change them.\n\n**Required scope:** `goals:delete`" } }, { "name": "Search Goals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goals/search", "host": [ "{{baseUrl}}" ], "path": [ "goals", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "owner,goalGroup", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "goalGroupId[eq]", "value": "pPAcKseY", "description": "Filter where `goalGroupId` equals.", "disabled": true }, { "key": "goalGroupId[in]", "value": "pPAcKseY,pPAcKseY", "description": "Filter where `goalGroupId` is one of (comma-separated list).", "disabled": true }, { "key": "ownerId[eq]", "value": "QpCuKyI2", "description": "Filter where `ownerId` equals.", "disabled": true }, { "key": "ownerId[in]", "value": "QpCuKyI2,QpCuKyI2", "description": "Filter where `ownerId` is one of (comma-separated list).", "disabled": true }, { "key": "endAt[eq]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` equals.", "disabled": true }, { "key": "endAt[gt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is greater than.", "disabled": true }, { "key": "endAt[gte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is greater than or equal to.", "disabled": true }, { "key": "endAt[lt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is less than.", "disabled": true }, { "key": "endAt[lte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `endAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across goals. Ranked by relevance; pages are capped at 200 results. Filterable by 6 fields.\n\n**Required scope:** `goals:read`" } } ] }, { "name": "Goal Group", "item": [ { "name": "List Goal Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goal-groups", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "goals,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List goalGroups. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 2 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `goal-groups:read`" } }, { "name": "Create Goal Group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/goal-groups", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups" ], "query": [ { "key": "expand", "value": "goals,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Goal Group. Server-assigned fields are ignored if sent.\n\n**Required scope:** `goal-groups:write`" } }, { "name": "Get Goal Group", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goal-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups", ":id" ], "query": [ { "key": "expand", "value": "goals,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "pPAcKseY", "description": "Id of the Goal Group." } ] }, "description": "Retrieve a single Goal Group by id.\n\n**Required scope:** `goal-groups:read`" } }, { "name": "Update Goal Group", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/goal-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups", ":id" ], "query": [ { "key": "expand", "value": "goals,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "pPAcKseY", "description": "Id of the Goal Group." } ] }, "description": "Partially update a Goal Group. Only the fields you send are changed.\n\n**Required scope:** `goal-groups:write`" } }, { "name": "Delete Goal Group", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/goal-groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups", ":id" ], "variable": [ { "key": "id", "value": "pPAcKseY", "description": "Id of the Goal Group." } ] }, "description": "Permanently delete this Goal Group. This cannot be undone. The goals in the group are NOT deleted: every one of them survives with `goalGroupId` set to null.\n\n**Required scope:** `goal-groups:delete`" } }, { "name": "Search Goal Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/goal-groups/search", "host": [ "{{baseUrl}}" ], "path": [ "goal-groups", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "goals,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across goalGroups. Ranked by relevance; pages are capped at 200 results. Filterable by 2 fields.\n\n**Required scope:** `goal-groups:read`" } } ] }, { "name": "Label", "item": [ { "name": "List Labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/labels", "host": [ "{{baseUrl}}" ], "path": [ "labels" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "color[eq]", "value": "#00A99B", "description": "Filter where `color` equals.", "disabled": true }, { "key": "color[in]", "value": "#00A99B,#00A99B", "description": "Filter where `color` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "others", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "others,member", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List labels. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 5 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `labels:read`" } }, { "name": "Create Label", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/labels", "host": [ "{{baseUrl}}" ], "path": [ "labels" ], "query": [ { "key": "expand", "value": "createdByActor,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Label. Server-assigned fields are ignored if sent. Send at least one of `name` or `color`; an empty body is rejected. Label names are unique per workspace among live labels, so reusing one returns 409.\n\n**Required scope:** `labels:write`" } }, { "name": "Get Label", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "labels", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "xbUMIqgS", "description": "Id of the Label." } ] }, "description": "Retrieve a single Label by id.\n\n**Required scope:** `labels:read`" } }, { "name": "Update Label", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "labels", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "xbUMIqgS", "description": "Id of the Label." } ] }, "description": "Partially update a Label. Only the fields you send are changed.\n\n**Required scope:** `labels:write`" } }, { "name": "Delete Label", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/labels/:id", "host": [ "{{baseUrl}}" ], "path": [ "labels", ":id" ], "variable": [ { "key": "id", "value": "xbUMIqgS", "description": "Id of the Label." } ] }, "description": "Move this Label to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `labels:delete`" } }, { "name": "Search Labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/labels/search", "host": [ "{{baseUrl}}" ], "path": [ "labels", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "color[eq]", "value": "#00A99B", "description": "Filter where `color` equals.", "disabled": true }, { "key": "color[in]", "value": "#00A99B,#00A99B", "description": "Filter where `color` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "others", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "others,member", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across labels. Ranked by relevance; pages are capped at 200 results. Filterable by 5 fields.\n\n**Required scope:** `labels:read`" } }, { "name": "Restore Label", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/labels/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "labels", ":id", "restore" ], "variable": [ { "key": "id", "value": "xbUMIqgS", "description": "Id of the Label." } ] }, "description": "Restore a Label that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `labels:delete`" } } ] }, { "name": "List", "item": [ { "name": "List Lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list lists across every project you can access.", "disabled": true }, { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "isMilestone[eq]", "value": "false", "description": "Filter where `isMilestone` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "dependencyId[eq]", "value": "i9TUmOWm", "description": "Filter where `dependencyId` equals.", "disabled": true }, { "key": "dependencyId[in]", "value": "i9TUmOWm,i9TUmOWm", "description": "Filter where `dependencyId` is one of (comma-separated list).", "disabled": true }, { "key": "statusId[eq]", "value": "5aM4ncwI", "description": "Filter where `statusId` equals.", "disabled": true }, { "key": "statusId[in]", "value": "5aM4ncwI,5aM4ncwI", "description": "Filter where `statusId` is one of (comma-separated list).", "disabled": true }, { "key": "ruleId[eq]", "value": "J55f2zQ2", "description": "Filter where `ruleId` equals.", "disabled": true }, { "key": "ruleId[in]", "value": "J55f2zQ2,J55f2zQ2", "description": "Filter where `ruleId` is one of (comma-separated list).", "disabled": true }, { "key": "start[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than.", "disabled": true }, { "key": "start[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than or equal to.", "disabled": true }, { "key": "start[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than.", "disabled": true }, { "key": "start[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than or equal to.", "disabled": true }, { "key": "end[gt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is greater than.", "disabled": true }, { "key": "end[gte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is greater than or equal to.", "disabled": true }, { "key": "end[lt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is less than.", "disabled": true }, { "key": "end[lte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List lists. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 11 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `lists:read`" } }, { "name": "Create List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"projectId\": \"iV6vIU8N\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists", "host": [ "{{baseUrl}}" ], "path": [ "lists" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a List. Server-assigned fields are ignored if sent.\n\n**Required scope:** `lists:write`" } }, { "name": "Get List", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Retrieve a single List by id.\n\n**Required scope:** `lists:read`" } }, { "name": "Update List", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Partially update a List. Only the fields you send are changed.\n\n**Required scope:** `lists:write`" } }, { "name": "Delete List", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/lists/:id", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Permanently delete this List. This cannot be undone.\n\n**Required scope:** `lists:delete`" } }, { "name": "Search Lists", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/lists/search", "host": [ "{{baseUrl}}" ], "path": [ "lists", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "projectId", "value": "iV6vIU8N", "description": "The project to search within. Required — lists are project-scoped and search has no workspace-wide mode.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "isMilestone[eq]", "value": "false", "description": "Filter where `isMilestone` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "dependencyId[eq]", "value": "i9TUmOWm", "description": "Filter where `dependencyId` equals.", "disabled": true }, { "key": "dependencyId[in]", "value": "i9TUmOWm,i9TUmOWm", "description": "Filter where `dependencyId` is one of (comma-separated list).", "disabled": true }, { "key": "statusId[eq]", "value": "5aM4ncwI", "description": "Filter where `statusId` equals.", "disabled": true }, { "key": "statusId[in]", "value": "5aM4ncwI,5aM4ncwI", "description": "Filter where `statusId` is one of (comma-separated list).", "disabled": true }, { "key": "ruleId[eq]", "value": "J55f2zQ2", "description": "Filter where `ruleId` equals.", "disabled": true }, { "key": "ruleId[in]", "value": "J55f2zQ2,J55f2zQ2", "description": "Filter where `ruleId` is one of (comma-separated list).", "disabled": true }, { "key": "start[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than.", "disabled": true }, { "key": "start[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than or equal to.", "disabled": true }, { "key": "start[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than.", "disabled": true }, { "key": "start[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than or equal to.", "disabled": true }, { "key": "end[gt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is greater than.", "disabled": true }, { "key": "end[gte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is greater than or equal to.", "disabled": true }, { "key": "end[lt]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is less than.", "disabled": true }, { "key": "end[lte]", "value": "2026-06-14T12:00:00.000Z", "description": "Filter where `end` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across lists. Ranked by relevance; pages are capped at 200 results. Filterable by 11 fields.\n\n**Required scope:** `lists:read`" } }, { "name": "Add assignees to a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/assignees", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "assignees" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Link the given ids to this List as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } }, { "name": "Remove assignees from a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/assignees/remove", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "assignees", "remove" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Unlink the given ids from this List's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } }, { "name": "Add hidden for to a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/hidden-for", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "hidden-for" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Link the given ids to this List as hiddenFor. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } }, { "name": "Remove hidden for from a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/hidden-for/remove", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "hidden-for", "remove" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Unlink the given ids from this List's hiddenFor. Removing one that is not linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } }, { "name": "Add goals to a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"AdESgais\",\n \"ij4ZIqgm\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/goals", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "goals" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Link the given ids to this List as goals. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete goals set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } }, { "name": "Remove goals from a List", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"AdESgais\",\n \"ij4ZIqgm\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/lists/:id/goals/remove", "host": [ "{{baseUrl}}" ], "path": [ "lists", ":id", "goals", "remove" ], "variable": [ { "key": "id", "value": "lN6ZQycO", "description": "Id of the List." } ] }, "description": "Unlink the given ids from this List's goals. Removing one that is not linked changes nothing. Returns the complete goals set afterwards.\n\n**Required scopes:** `lists:write` `lists:link`" } } ] }, { "name": "Team Member", "item": [ { "name": "List Team Members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/members", "host": [ "{{baseUrl}}" ], "path": [ "members" ], "query": [ { "key": "sort", "value": "name", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `name`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "customFields", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "email[eq]", "value": "jane@acme.com", "description": "Filter where `email` equals.", "disabled": true }, { "key": "email[contains]", "value": "jane@acme.com", "description": "Filter where `email` contains.", "disabled": true }, { "key": "online[eq]", "value": "false", "description": "Filter where `online` equals.", "disabled": true }, { "key": "pending[eq]", "value": "false", "description": "Filter where `pending` equals.", "disabled": true } ] }, "description": "List members. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `name` unless you pass `sort`.\n\n**Required scope:** `members:read`" } }, { "name": "Create Team Member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"jane@acme.com\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members", "host": [ "{{baseUrl}}" ], "path": [ "members" ], "query": [ { "key": "expand", "value": "customFields", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Team Member. Server-assigned fields are ignored if sent. Creating a member is an invitation. It emails the address you supply, consumes a seat (a team at its plan limit gets 409), and needs the `inviteToTeam` permission — plus `inviteToProject` if you pass `projectId`. It is idempotent on an email that is already active (you get the existing member back), it reactivates a previously removed member rather than creating a second one, and it cannot invite someone as `owner`. Only `email`, `name`, `roleId` and `projectId` are read; everything else on the member is either set by the person themselves or derived.\n\n**Required scope:** `members:write`" } }, { "name": "Get Team Member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "query": [ { "key": "expand", "value": "customFields", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "P3hYIKqK", "description": "Id of the Team Member." } ] }, "description": "Retrieve a single Team Member by id.\n\n**Required scope:** `members:read`" } }, { "name": "Update Team Member", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "query": [ { "key": "expand", "value": "customFields", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "P3hYIKqK", "description": "Id of the Team Member." } ] }, "description": "Partially update a Team Member. Only the fields you send are changed.\n\n**Required scope:** `members:write`" } }, { "name": "Delete Team Member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/members/:id", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id" ], "variable": [ { "key": "id", "value": "P3hYIKqK", "description": "Id of the Team Member." } ] }, "description": "Deactivate this Team Member. It stops appearing in list results but the record is preserved and can be restored. This removes the person from the team and cascades: their task, list and status assignments are handed to the team owner, their chat and document memberships are dropped, their notifications are purged and their tokens are revoked. It requires `removeFromTeam`, and the team owner cannot be removed. Restoring the member restores the membership only — reassigned tasks, dropped chat and document memberships, and revoked tokens all stay as the removal left them.\n\n**Required scope:** `members:delete`" } }, { "name": "Restore Team Member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/members/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "members", ":id", "restore" ], "variable": [ { "key": "id", "value": "P3hYIKqK", "description": "Id of the Team Member." } ] }, "description": "Restore a Team Member that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `members:delete`" } } ] }, { "name": "Message", "item": [ { "name": "List Messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/messages", "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "author,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "authorId[eq]", "value": "EPmKiCaK", "description": "Filter where `authorId` equals.", "disabled": true }, { "key": "authorId[in]", "value": "EPmKiCaK,EPmKiCaK", "description": "Filter where `authorId` is one of (comma-separated list).", "disabled": true }, { "key": "chatId[eq]", "value": "hTIeouEK", "description": "Filter where `chatId` equals.", "disabled": true }, { "key": "chatId[in]", "value": "hTIeouEK,hTIeouEK", "description": "Filter where `chatId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "documentId[eq]", "value": "ELe0nkum", "description": "Filter where `documentId` equals.", "disabled": true }, { "key": "documentId[in]", "value": "ELe0nkum,ELe0nkum", "description": "Filter where `documentId` is one of (comma-separated list).", "disabled": true }, { "key": "fileId[eq]", "value": "xvM2toUM", "description": "Filter where `fileId` equals.", "disabled": true }, { "key": "fileId[in]", "value": "xvM2toUM,xvM2toUM", "description": "Filter where `fileId` is one of (comma-separated list).", "disabled": true }, { "key": "annotationId[eq]", "value": "863BiyIc", "description": "Filter where `annotationId` equals.", "disabled": true }, { "key": "annotationId[in]", "value": "863BiyIc,863BiyIc", "description": "Filter where `annotationId` is one of (comma-separated list).", "disabled": true }, { "key": "parentMessageId[eq]", "value": "gx21BskY", "description": "Filter where `parentMessageId` equals.", "disabled": true }, { "key": "parentMessageId[in]", "value": "gx21BskY,gx21BskY", "description": "Filter where `parentMessageId` is one of (comma-separated list).", "disabled": true }, { "key": "sharedDocumentId[eq]", "value": "vjciEwQy", "description": "Filter where `sharedDocumentId` equals.", "disabled": true }, { "key": "sharedDocumentId[in]", "value": "vjciEwQy,vjciEwQy", "description": "Filter where `sharedDocumentId` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "text", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "text,gif", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "subtype[eq]", "value": "hello", "description": "Filter where `subtype` equals.", "disabled": true }, { "key": "subtype[in]", "value": "hello,joinProject", "description": "Filter where `subtype` is one of (comma-separated list).", "disabled": true }, { "key": "subtype[null]", "value": "true", "description": "Filter where `subtype` is null (pass `true`).", "disabled": true }, { "key": "subtype[notNull]", "value": "true", "description": "Filter where `subtype` is not null (pass `true`).", "disabled": true }, { "key": "isEdited[eq]", "value": "false", "description": "Filter where `isEdited` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List messages. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 14 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `messages:read`" } }, { "name": "Create Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/messages", "host": [ "{{baseUrl}}" ], "path": [ "messages" ], "query": [ { "key": "expand", "value": "author,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Message. Server-assigned fields are ignored if sent.\n\n**Required scope:** `messages:write`" } }, { "name": "Get Message", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "messages", ":id" ], "query": [ { "key": "expand", "value": "author,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "4SsY67bC", "description": "Id of the Message." } ] }, "description": "Retrieve a single Message by id.\n\n**Required scope:** `messages:read`" } }, { "name": "Update Message", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "messages", ":id" ], "query": [ { "key": "expand", "value": "author,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "4SsY67bC", "description": "Id of the Message." } ] }, "description": "Partially update a Message. Only the fields you send are changed.\n\n**Required scope:** `messages:write`" } }, { "name": "Delete Message", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/messages/:id", "host": [ "{{baseUrl}}" ], "path": [ "messages", ":id" ], "variable": [ { "key": "id", "value": "4SsY67bC", "description": "Id of the Message." } ] }, "description": "Move this Message to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `messages:delete`" } }, { "name": "Search Messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/messages/search", "host": [ "{{baseUrl}}" ], "path": [ "messages", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "author,deletedBy", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "authorId[eq]", "value": "EPmKiCaK", "description": "Filter where `authorId` equals.", "disabled": true }, { "key": "authorId[in]", "value": "EPmKiCaK,EPmKiCaK", "description": "Filter where `authorId` is one of (comma-separated list).", "disabled": true }, { "key": "chatId[eq]", "value": "hTIeouEK", "description": "Filter where `chatId` equals.", "disabled": true }, { "key": "chatId[in]", "value": "hTIeouEK,hTIeouEK", "description": "Filter where `chatId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "documentId[eq]", "value": "ELe0nkum", "description": "Filter where `documentId` equals.", "disabled": true }, { "key": "documentId[in]", "value": "ELe0nkum,ELe0nkum", "description": "Filter where `documentId` is one of (comma-separated list).", "disabled": true }, { "key": "fileId[eq]", "value": "xvM2toUM", "description": "Filter where `fileId` equals.", "disabled": true }, { "key": "fileId[in]", "value": "xvM2toUM,xvM2toUM", "description": "Filter where `fileId` is one of (comma-separated list).", "disabled": true }, { "key": "annotationId[eq]", "value": "863BiyIc", "description": "Filter where `annotationId` equals.", "disabled": true }, { "key": "annotationId[in]", "value": "863BiyIc,863BiyIc", "description": "Filter where `annotationId` is one of (comma-separated list).", "disabled": true }, { "key": "parentMessageId[eq]", "value": "gx21BskY", "description": "Filter where `parentMessageId` equals.", "disabled": true }, { "key": "parentMessageId[in]", "value": "gx21BskY,gx21BskY", "description": "Filter where `parentMessageId` is one of (comma-separated list).", "disabled": true }, { "key": "sharedDocumentId[eq]", "value": "vjciEwQy", "description": "Filter where `sharedDocumentId` equals.", "disabled": true }, { "key": "sharedDocumentId[in]", "value": "vjciEwQy,vjciEwQy", "description": "Filter where `sharedDocumentId` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "text", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "text,gif", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "subtype[eq]", "value": "hello", "description": "Filter where `subtype` equals.", "disabled": true }, { "key": "subtype[in]", "value": "hello,joinProject", "description": "Filter where `subtype` is one of (comma-separated list).", "disabled": true }, { "key": "subtype[null]", "value": "true", "description": "Filter where `subtype` is null (pass `true`).", "disabled": true }, { "key": "subtype[notNull]", "value": "true", "description": "Filter where `subtype` is not null (pass `true`).", "disabled": true }, { "key": "isEdited[eq]", "value": "false", "description": "Filter where `isEdited` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across messages. Ranked by relevance; pages are capped at 200 results. Filterable by 14 fields.\n\n**Required scope:** `messages:read`" } }, { "name": "Restore Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/messages/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "messages", ":id", "restore" ], "variable": [ { "key": "id", "value": "4SsY67bC", "description": "Id of the Message." } ] }, "description": "Restore a Message that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `messages:delete`" } } ] }, { "name": "Portfolio", "item": [ { "name": "List Portfolios", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/portfolios", "host": [ "{{baseUrl}}" ], "path": [ "portfolios" ], "query": [ { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "owner,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "isGeneral[eq]", "value": "false", "description": "Filter where `isGeneral` equals.", "disabled": true }, { "key": "order[eq]", "value": "2000", "description": "Filter where `order` equals.", "disabled": true }, { "key": "order[gt]", "value": "2000", "description": "Filter where `order` is greater than.", "disabled": true }, { "key": "order[gte]", "value": "2000", "description": "Filter where `order` is greater than or equal to.", "disabled": true }, { "key": "order[lt]", "value": "2000", "description": "Filter where `order` is less than.", "disabled": true }, { "key": "order[lte]", "value": "2000", "description": "Filter where `order` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List portfolios. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 5 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `portfolios:read`" } }, { "name": "Create Portfolio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/portfolios", "host": [ "{{baseUrl}}" ], "path": [ "portfolios" ], "query": [ { "key": "expand", "value": "owner,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Portfolio. Server-assigned fields are ignored if sent.\n\n**Required scope:** `portfolios:write`" } }, { "name": "Get Portfolio", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/portfolios/:id", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id" ], "query": [ { "key": "expand", "value": "owner,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Retrieve a single Portfolio by id.\n\n**Required scope:** `portfolios:read`" } }, { "name": "Update Portfolio", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/portfolios/:id", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id" ], "query": [ { "key": "expand", "value": "owner,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Partially update a Portfolio. Only the fields you send are changed.\n\n**Required scope:** `portfolios:write`" } }, { "name": "Delete Portfolio", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/portfolios/:id", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id" ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Move this Portfolio to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `portfolios:delete`" } }, { "name": "Search Portfolios", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/portfolios/search", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "owner,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "isGeneral[eq]", "value": "false", "description": "Filter where `isGeneral` equals.", "disabled": true }, { "key": "order[eq]", "value": "2000", "description": "Filter where `order` equals.", "disabled": true }, { "key": "order[gt]", "value": "2000", "description": "Filter where `order` is greater than.", "disabled": true }, { "key": "order[gte]", "value": "2000", "description": "Filter where `order` is greater than or equal to.", "disabled": true }, { "key": "order[lt]", "value": "2000", "description": "Filter where `order` is less than.", "disabled": true }, { "key": "order[lte]", "value": "2000", "description": "Filter where `order` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across portfolios. Ranked by relevance; pages are capped at 200 results. Filterable by 5 fields.\n\n**Required scope:** `portfolios:read`" } }, { "name": "Add members to a Portfolio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/portfolios/:id/members", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id", "members" ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Link the given ids to this Portfolio as members. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete members set afterwards.\n\n**Required scopes:** `portfolios:write` `portfolios:link`" } }, { "name": "Remove members from a Portfolio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/portfolios/:id/members/remove", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id", "members", "remove" ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Unlink the given ids from this Portfolio's members. Removing one that is not linked changes nothing. Returns the complete members set afterwards.\n\n**Required scopes:** `portfolios:write` `portfolios:link`" } }, { "name": "Restore Portfolio", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/portfolios/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "portfolios", ":id", "restore" ], "variable": [ { "key": "id", "value": "1YEYsy2X", "description": "Id of the Portfolio." } ] }, "description": "Restore a Portfolio that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `portfolios:delete`" } } ] }, { "name": "Presence Status", "item": [ { "name": "List Presence Statuses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/presence-statuses", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "isDefault[eq]", "value": "false", "description": "Filter where `isDefault` equals.", "disabled": true }, { "key": "appearsOnline[eq]", "value": "false", "description": "Filter where `appearsOnline` equals.", "disabled": true } ] }, "description": "List presenceStatuses. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `presence-statuses:read`" } }, { "name": "Create Presence Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"appearsOnline\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presence-statuses", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Presence Status. Server-assigned fields are ignored if sent.\n\n**Required scope:** `presence-statuses:write`" } }, { "name": "Get Presence Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/presence-statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses", ":id" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "WjkiuqmY", "description": "Id of the Presence Status." } ] }, "description": "Retrieve a single Presence Status by id.\n\n**Required scope:** `presence-statuses:read`" } }, { "name": "Update Presence Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/presence-statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses", ":id" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "WjkiuqmY", "description": "Id of the Presence Status." } ] }, "description": "Partially update a Presence Status. Only the fields you send are changed.\n\n**Required scope:** `presence-statuses:write`" } }, { "name": "Delete Presence Status", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/presence-statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses", ":id" ], "variable": [ { "key": "id", "value": "WjkiuqmY", "description": "Id of the Presence Status." } ] }, "description": "Permanently delete this Presence Status. This cannot be undone.\n\n**Required scope:** `presence-statuses:delete`" } }, { "name": "Search Presence Statuses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/presence-statuses/search", "host": [ "{{baseUrl}}" ], "path": [ "presence-statuses", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "isDefault[eq]", "value": "false", "description": "Filter where `isDefault` equals.", "disabled": true }, { "key": "appearsOnline[eq]", "value": "false", "description": "Filter where `appearsOnline` equals.", "disabled": true } ] }, "description": "Full-text ranked search across presenceStatuses. Ranked by relevance; pages are capped at 200 results. Filterable by 3 fields.\n\n**Required scope:** `presence-statuses:read`" } } ] }, { "name": "Project", "item": [ { "name": "List Projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "portfolioId[eq]", "value": "1YEYsy2X", "description": "Filter where `portfolioId` equals.", "disabled": true }, { "key": "portfolioId[in]", "value": "1YEYsy2X,1YEYsy2X", "description": "Filter where `portfolioId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List projects. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 6 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `projects:read`" } }, { "name": "Create Project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects", "host": [ "{{baseUrl}}" ], "path": [ "projects" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Project. Server-assigned fields are ignored if sent.\n\n**Required scope:** `projects:write`" } }, { "name": "Get Project", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Retrieve a single Project by id.\n\n**Required scope:** `projects:read`" } }, { "name": "Update Project", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Partially update a Project. Only the fields you send are changed.\n\n**Required scope:** `projects:write`" } }, { "name": "Delete Project", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/projects/:id", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id" ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Move this Project to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `projects:delete`" } }, { "name": "Search Projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/projects/search", "host": [ "{{baseUrl}}" ], "path": [ "projects", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "accessType[eq]", "value": "public", "description": "Filter where `accessType` equals.", "disabled": true }, { "key": "accessType[in]", "value": "public,limited", "description": "Filter where `accessType` is one of (comma-separated list).", "disabled": true }, { "key": "portfolioId[eq]", "value": "1YEYsy2X", "description": "Filter where `portfolioId` equals.", "disabled": true }, { "key": "portfolioId[in]", "value": "1YEYsy2X,1YEYsy2X", "description": "Filter where `portfolioId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across projects. Ranked by relevance; pages are capped at 200 results. Filterable by 6 fields.\n\n**Required scope:** `projects:read`" } }, { "name": "Transfer (Project)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:id/transfer", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "transfer" ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Transfer project ownership to another member.\n\n**Required scope:** `projects:write`" } }, { "name": "Add members to a Project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:id/members", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "members" ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Add an existing team member to this project.\n\n**Required scope:** `projects:write`" } }, { "name": "Remove members from a Project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/projects/:id/members/remove", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "members", "remove" ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Remove a member from this project.\n\n**Required scope:** `projects:delete`" } }, { "name": "Restore Project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/projects/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "projects", ":id", "restore" ], "variable": [ { "key": "id", "value": "iV6vIU8N", "description": "Id of the Project." } ] }, "description": "Restore a Project that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `projects:delete`" } } ] }, { "name": "Project activity", "item": [ { "name": "List Project activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-activities", "host": [ "{{baseUrl}}" ], "path": [ "project-activities" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list projectActivities across every project you can access.", "disabled": true }, { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "type[eq]", "value": "taskCompleted", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "taskCompleted,usersJoined", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "listId[eq]", "value": "lN6ZQycO", "description": "Filter where `listId` equals.", "disabled": true }, { "key": "listId[in]", "value": "lN6ZQycO,lN6ZQycO", "description": "Filter where `listId` is one of (comma-separated list).", "disabled": true }, { "key": "documentId[eq]", "value": "ELe0nkum", "description": "Filter where `documentId` equals.", "disabled": true }, { "key": "documentId[in]", "value": "ELe0nkum,ELe0nkum", "description": "Filter where `documentId` is one of (comma-separated list).", "disabled": true }, { "key": "fileId[eq]", "value": "xvM2toUM", "description": "Filter where `fileId` equals.", "disabled": true }, { "key": "fileId[in]", "value": "xvM2toUM,xvM2toUM", "description": "Filter where `fileId` is one of (comma-separated list).", "disabled": true }, { "key": "triggeredById[eq]", "value": "lvc47DE8", "description": "Filter where `triggeredById` equals.", "disabled": true }, { "key": "triggeredById[in]", "value": "lvc47DE8,lvc47DE8", "description": "Filter where `triggeredById` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List projectActivities. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 8 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `project-activities:read`" } }, { "name": "Get Project activity", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-activities/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-activities", ":id" ], "query": [ { "key": "expand", "value": "project,task", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "Nl0Hmwsa", "description": "Id of the Project activity." } ] }, "description": "Retrieve a single Project activity by id.\n\n**Required scope:** `project-activities:read`" } } ] }, { "name": "Project Dashboard", "item": [ { "name": "List Project Dashboards", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "project-dashboards" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list projectDashboards across every project you can access.", "disabled": true }, { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "isShared[eq]", "value": "false", "description": "Filter where `isShared` equals.", "disabled": true }, { "key": "isDefault[eq]", "value": "false", "description": "Filter where `isDefault` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "createdById[eq]", "value": "JvMMIoOQ", "description": "Filter where `createdById` equals.", "disabled": true }, { "key": "createdById[in]", "value": "JvMMIoOQ,JvMMIoOQ", "description": "Filter where `createdById` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List projectDashboards. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 6 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `project-dashboards:read`" } }, { "name": "Create Project Dashboard", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"projectId\": \"iV6vIU8N\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/project-dashboards", "host": [ "{{baseUrl}}" ], "path": [ "project-dashboards" ], "query": [ { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Project Dashboard. Server-assigned fields are ignored if sent.\n\n**Required scope:** `project-dashboards:write`" } }, { "name": "Get Project Dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-dashboards/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-dashboards", ":id" ], "query": [ { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "udOQuo4n", "description": "Id of the Project Dashboard." } ] }, "description": "Retrieve a single Project Dashboard by id.\n\n**Required scope:** `project-dashboards:read`" } }, { "name": "Update Project Dashboard", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/project-dashboards/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-dashboards", ":id" ], "query": [ { "key": "expand", "value": "project,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "udOQuo4n", "description": "Id of the Project Dashboard." } ] }, "description": "Partially update a Project Dashboard. Only the fields you send are changed.\n\n**Required scope:** `project-dashboards:write`" } }, { "name": "Delete Project Dashboard", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/project-dashboards/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-dashboards", ":id" ], "variable": [ { "key": "id", "value": "udOQuo4n", "description": "Id of the Project Dashboard." } ] }, "description": "Permanently delete this Project Dashboard. This cannot be undone. The dashboard's widgets are deleted with it.\n\n**Required scope:** `project-dashboards:delete`" } } ] }, { "name": "Project Folder", "item": [ { "name": "List Project Folders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-folders", "host": [ "{{baseUrl}}" ], "path": [ "project-folders" ], "query": [ { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "portfolio,projects", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "portfolioId[eq]", "value": "1YEYsy2X", "description": "Filter where `portfolioId` equals.", "disabled": true }, { "key": "portfolioId[in]", "value": "1YEYsy2X,1YEYsy2X", "description": "Filter where `portfolioId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List projectFolders. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `project-folders:read`" } }, { "name": "Create Project Folder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"portfolioId\": \"1YEYsy2X\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/project-folders", "host": [ "{{baseUrl}}" ], "path": [ "project-folders" ], "query": [ { "key": "expand", "value": "portfolio,projects", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Project Folder. Server-assigned fields are ignored if sent.\n\n**Required scope:** `project-folders:write`" } }, { "name": "Get Project Folder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/project-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-folders", ":id" ], "query": [ { "key": "expand", "value": "portfolio,projects", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "0sSAIGwG", "description": "Id of the Project Folder." } ] }, "description": "Retrieve a single Project Folder by id.\n\n**Required scope:** `project-folders:read`" } }, { "name": "Update Project Folder", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/project-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-folders", ":id" ], "query": [ { "key": "expand", "value": "portfolio,projects", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "0sSAIGwG", "description": "Id of the Project Folder." } ] }, "description": "Partially update a Project Folder. Only the fields you send are changed.\n\n**Required scope:** `project-folders:write`" } }, { "name": "Delete Project Folder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/project-folders/:id", "host": [ "{{baseUrl}}" ], "path": [ "project-folders", ":id" ], "variable": [ { "key": "id", "value": "0sSAIGwG", "description": "Id of the Project Folder." } ] }, "description": "Permanently delete this Project Folder. This cannot be undone. The projects filed in the folder are NOT deleted — they become unfiled (`projectFolderId: null`).\n\n**Required scope:** `project-folders:delete`" } } ] }, { "name": "Recurring Rule", "item": [ { "name": "List Recurring Rules", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recurring-rules", "host": [ "{{baseUrl}}" ], "path": [ "recurring-rules" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list recurringRules across every project you can access.", "disabled": true }, { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "sourceTask,targetStatus", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "type[eq]", "value": "date", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "date,status", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "sourceTaskId[eq]", "value": "5MM8V0rW", "description": "Filter where `sourceTaskId` equals.", "disabled": true }, { "key": "sourceTaskId[in]", "value": "5MM8V0rW,5MM8V0rW", "description": "Filter where `sourceTaskId` is one of (comma-separated list).", "disabled": true }, { "key": "nextRecurrenceAt[gt]", "value": "2026-06-01T16:00:00.000Z", "description": "Filter where `nextRecurrenceAt` is greater than.", "disabled": true }, { "key": "nextRecurrenceAt[gte]", "value": "2026-06-01T16:00:00.000Z", "description": "Filter where `nextRecurrenceAt` is greater than or equal to.", "disabled": true }, { "key": "nextRecurrenceAt[lt]", "value": "2026-06-01T16:00:00.000Z", "description": "Filter where `nextRecurrenceAt` is less than.", "disabled": true }, { "key": "nextRecurrenceAt[lte]", "value": "2026-06-01T16:00:00.000Z", "description": "Filter where `nextRecurrenceAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List recurringRules. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `recurring-rules:read`" } }, { "name": "Create Recurring Rule", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"date\",\n \"sourceTaskId\": \"5MM8V0rW\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring-rules", "host": [ "{{baseUrl}}" ], "path": [ "recurring-rules" ], "query": [ { "key": "expand", "value": "sourceTask,targetStatus", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Recurring Rule. Server-assigned fields are ignored if sent.\n\n**Required scope:** `recurring-rules:write`" } }, { "name": "Get Recurring Rule", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/recurring-rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-rules", ":id" ], "query": [ { "key": "expand", "value": "sourceTask,targetStatus", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "cn2v0xiQ", "description": "Id of the Recurring Rule." } ] }, "description": "Retrieve a single Recurring Rule by id.\n\n**Required scope:** `recurring-rules:read`" } }, { "name": "Update Recurring Rule", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/recurring-rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-rules", ":id" ], "query": [ { "key": "expand", "value": "sourceTask,targetStatus", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "cn2v0xiQ", "description": "Id of the Recurring Rule." } ] }, "description": "Partially update a Recurring Rule. Only the fields you send are changed.\n\n**Required scope:** `recurring-rules:write`" } }, { "name": "Delete Recurring Rule", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/recurring-rules/:id", "host": [ "{{baseUrl}}" ], "path": [ "recurring-rules", ":id" ], "variable": [ { "key": "id", "value": "cn2v0xiQ", "description": "Id of the Recurring Rule." } ] }, "description": "Permanently delete this Recurring Rule. This cannot be undone.\n\n**Required scope:** `recurring-rules:delete`" } } ] }, { "name": "Reminder", "item": [ { "name": "List Reminders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reminders", "host": [ "{{baseUrl}}" ], "path": [ "reminders" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list reminders across every project you can access.", "disabled": true }, { "key": "sort", "value": "date", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `date`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "type[eq]", "value": "custom", "description": "Filter where `type` equals.", "disabled": true }, { "key": "type[in]", "value": "custom,custom", "description": "Filter where `type` is one of (comma-separated list).", "disabled": true }, { "key": "date[eq]", "value": "2026-09-01T09:00:00.000Z", "description": "Filter where `date` equals.", "disabled": true }, { "key": "date[gt]", "value": "2026-09-01T09:00:00.000Z", "description": "Filter where `date` is greater than.", "disabled": true }, { "key": "date[gte]", "value": "2026-09-01T09:00:00.000Z", "description": "Filter where `date` is greater than or equal to.", "disabled": true }, { "key": "date[lt]", "value": "2026-09-01T09:00:00.000Z", "description": "Filter where `date` is less than.", "disabled": true }, { "key": "date[lte]", "value": "2026-09-01T09:00:00.000Z", "description": "Filter where `date` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List reminders. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `date` unless you pass `sort`.\n\n**Required scope:** `reminders:read`" } }, { "name": "Create Reminder", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"date\": \"2026-09-01T09:00:00.000Z\",\n \"taskId\": \"KfS0ha8P\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/reminders", "host": [ "{{baseUrl}}" ], "path": [ "reminders" ], "query": [ { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Reminder. Server-assigned fields are ignored if sent.\n\n**Required scope:** `reminders:write`" } }, { "name": "Get Reminder", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/reminders/:id", "host": [ "{{baseUrl}}" ], "path": [ "reminders", ":id" ], "query": [ { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "PHIAeeke", "description": "Id of the Reminder." } ] }, "description": "Retrieve a single Reminder by id.\n\n**Required scope:** `reminders:read`" } }, { "name": "Update Reminder", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/reminders/:id", "host": [ "{{baseUrl}}" ], "path": [ "reminders", ":id" ], "query": [ { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "PHIAeeke", "description": "Id of the Reminder." } ] }, "description": "Partially update a Reminder. Only the fields you send are changed.\n\n**Required scope:** `reminders:write`" } }, { "name": "Delete Reminder", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/reminders/:id", "host": [ "{{baseUrl}}" ], "path": [ "reminders", ":id" ], "variable": [ { "key": "id", "value": "PHIAeeke", "description": "Id of the Reminder." } ] }, "description": "Permanently delete this Reminder. This cannot be undone.\n\n**Required scope:** `reminders:delete`" } } ] }, { "name": "Report Chart", "item": [ { "name": "List Report Charts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/report-charts", "host": [ "{{baseUrl}}" ], "path": [ "report-charts" ], "query": [ { "key": "sort", "value": "createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "projects,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "dataType[eq]", "value": "live", "description": "Filter where `dataType` equals.", "disabled": true }, { "key": "chartType[eq]", "value": "line", "description": "Filter where `chartType` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List reportCharts. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `createdAt` unless you pass `sort`.\n\n**Required scope:** `report-charts:read`" } }, { "name": "Create Report Chart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"dataType\": \"live\",\n \"chartType\": \"line\",\n \"projects\": [\n \"iV6vIU8N\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/report-charts", "host": [ "{{baseUrl}}" ], "path": [ "report-charts" ], "query": [ { "key": "expand", "value": "projects,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Report Chart. Server-assigned fields are ignored if sent.\n\n**Required scope:** `report-charts:write`" } }, { "name": "Get Report Chart", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/report-charts/:id", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":id" ], "query": [ { "key": "expand", "value": "projects,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "Z3hEUMCq", "description": "Id of the Report Chart." } ] }, "description": "Retrieve a single Report Chart by id.\n\n**Required scope:** `report-charts:read`" } }, { "name": "Update Report Chart", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/report-charts/:id", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":id" ], "query": [ { "key": "expand", "value": "projects,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "Z3hEUMCq", "description": "Id of the Report Chart." } ] }, "description": "Partially update a Report Chart. Only the fields you send are changed.\n\n**Required scope:** `report-charts:write`" } }, { "name": "Delete Report Chart", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/report-charts/:id", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":id" ], "variable": [ { "key": "id", "value": "Z3hEUMCq", "description": "Id of the Report Chart." } ] }, "description": "Permanently delete this Report Chart. This cannot be undone.\n\n**Required scope:** `report-charts:delete`" } }, { "name": "Add projects to a Report Chart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"iV6vIU8N\",\n \"QPw2r8rm\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/report-charts/:id/projects", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":id", "projects" ], "variable": [ { "key": "id", "value": "Z3hEUMCq", "description": "Id of the Report Chart." } ] }, "description": "Link the given ids to this Report Chart as projects. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete projects set afterwards.\n\n**Required scopes:** `report-charts:write` `report-charts:link`" } }, { "name": "Remove projects from a Report Chart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"iV6vIU8N\",\n \"QPw2r8rm\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/report-charts/:id/projects/remove", "host": [ "{{baseUrl}}" ], "path": [ "report-charts", ":id", "projects", "remove" ], "variable": [ { "key": "id", "value": "Z3hEUMCq", "description": "Id of the Report Chart." } ] }, "description": "Unlink the given ids from this Report Chart's projects. Removing one that is not linked changes nothing. Returns the complete projects set afterwards.\n\n**Required scopes:** `report-charts:write` `report-charts:link`" } } ] }, { "name": "Role", "item": [ { "name": "List Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ], "query": [ { "key": "sort", "value": "name", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `name`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "editable[eq]", "value": "false", "description": "Filter where `editable` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List roles. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by `name` unless you pass `sort`.\n\n**Required scope:** `roles:read`" } }, { "name": "Create Role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles", "host": [ "{{baseUrl}}" ], "path": [ "roles" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Role. Server-assigned fields are ignored if sent.\n\n**Required scope:** `roles:write`" } }, { "name": "Get Role", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":id" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "zngY4nUy", "description": "Id of the Role." } ] }, "description": "Retrieve a single Role by id.\n\n**Required scope:** `roles:read`" } }, { "name": "Update Role", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":id" ], "query": [ { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "zngY4nUy", "description": "Id of the Role." } ] }, "description": "Partially update a Role. Only the fields you send are changed.\n\n**Required scope:** `roles:write`" } }, { "name": "Delete Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/roles/:id", "host": [ "{{baseUrl}}" ], "path": [ "roles", ":id" ], "variable": [ { "key": "id", "value": "zngY4nUy", "description": "Id of the Role." } ] }, "description": "Permanently delete this Role. This cannot be undone. There are four possible outcomes. A built-in role is refused with 403. A role still held by an active member is refused with 409 — reassign them first. On success, anyone previously removed from the team who still held the role is moved to `regular`; if the workspace has no `regular` role, the delete is refused with 409 instead.\n\n**Required scope:** `roles:delete`" } }, { "name": "Search Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/roles/search", "host": [ "{{baseUrl}}" ], "path": [ "roles", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "editable[eq]", "value": "false", "description": "Filter where `editable` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across roles. Ranked by relevance; pages are capped at 200 results. Filterable by 3 fields.\n\n**Required scope:** `roles:read`" } } ] }, { "name": "Status", "item": [ { "name": "List Statuses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/statuses", "host": [ "{{baseUrl}}" ], "path": [ "statuses" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list statuses across every project you can access.", "disabled": true }, { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List statuses. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 5 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `statuses:read`" } }, { "name": "Create Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"projectId\": \"iV6vIU8N\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses", "host": [ "{{baseUrl}}" ], "path": [ "statuses" ], "query": [ { "key": "expand", "value": "createdByActor,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Status. Server-assigned fields are ignored if sent.\n\n**Required scope:** `statuses:write`" } }, { "name": "Get Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Retrieve a single Status by id.\n\n**Required scope:** `statuses:read`" } }, { "name": "Update Status", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Partially update a Status. Only the fields you send are changed.\n\n**Required scope:** `statuses:write`" } }, { "name": "Delete Status", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/statuses/:id", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id" ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Permanently delete this Status. This cannot be undone.\n\n**Required scope:** `statuses:delete`" } }, { "name": "Search Statuses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/statuses/search", "host": [ "{{baseUrl}}" ], "path": [ "statuses", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "projectId", "value": "iV6vIU8N", "description": "The project to search within. Required — statuses are project-scoped and search has no workspace-wide mode.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,project", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across statuses. Ranked by relevance; pages are capped at 200 results. Filterable by 5 fields.\n\n**Required scope:** `statuses:read`" } }, { "name": "Add assignees to a Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses/:id/assignees", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id", "assignees" ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Link the given ids to this Status as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `statuses:write` `statuses:link`" } }, { "name": "Remove assignees from a Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses/:id/assignees/remove", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id", "assignees", "remove" ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Unlink the given ids from this Status's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `statuses:write` `statuses:link`" } }, { "name": "Add hidden for to a Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses/:id/hidden-for", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id", "hidden-for" ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Link the given ids to this Status as hiddenFor. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `statuses:write` `statuses:link`" } }, { "name": "Remove hidden for from a Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/statuses/:id/hidden-for/remove", "host": [ "{{baseUrl}}" ], "path": [ "statuses", ":id", "hidden-for", "remove" ], "variable": [ { "key": "id", "value": "5aM4ncwI", "description": "Id of the Status." } ] }, "description": "Unlink the given ids from this Status's hiddenFor. Removing one that is not linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `statuses:write` `statuses:link`" } } ] }, { "name": "Task", "item": [ { "name": "List Tasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list tasks across every project you can access.", "disabled": true }, { "key": "scope", "value": "both", "description": "Which tasks a workspace-wide list returns: `project` (rows that belong to a project you can access), `personal` (your own rows, which belong to no project), or `both`. Ignored when you pass `projectId`. Default: `both`.", "disabled": true }, { "key": "sort", "value": "order", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `order`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,status", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "niceId[eq]", "value": "1234", "description": "Filter where `niceId` equals.", "disabled": true }, { "key": "niceId[in]", "value": "1234,1234", "description": "Filter where `niceId` is one of (comma-separated list).", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "completed[eq]", "value": "false", "description": "Filter where `completed` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "listId[eq]", "value": "lN6ZQycO", "description": "Filter where `listId` equals.", "disabled": true }, { "key": "listId[in]", "value": "lN6ZQycO,lN6ZQycO", "description": "Filter where `listId` is one of (comma-separated list).", "disabled": true }, { "key": "statusId[eq]", "value": "5aM4ncwI", "description": "Filter where `statusId` equals.", "disabled": true }, { "key": "statusId[in]", "value": "5aM4ncwI,5aM4ncwI", "description": "Filter where `statusId` is one of (comma-separated list).", "disabled": true }, { "key": "parentTaskId[eq]", "value": "4KOocqYo", "description": "Filter where `parentTaskId` equals.", "disabled": true }, { "key": "parentTaskId[in]", "value": "4KOocqYo,4KOocqYo", "description": "Filter where `parentTaskId` is one of (comma-separated list).", "disabled": true }, { "key": "dependencyId[eq]", "value": "i9TUmOWm", "description": "Filter where `dependencyId` equals.", "disabled": true }, { "key": "dependencyId[in]", "value": "i9TUmOWm,i9TUmOWm", "description": "Filter where `dependencyId` is one of (comma-separated list).", "disabled": true }, { "key": "recurringRuleId[eq]", "value": "cn2v0xiQ", "description": "Filter where `recurringRuleId` equals.", "disabled": true }, { "key": "recurringRuleId[in]", "value": "cn2v0xiQ,cn2v0xiQ", "description": "Filter where `recurringRuleId` is one of (comma-separated list).", "disabled": true }, { "key": "createdById[eq]", "value": "njWQkGgk", "description": "Filter where `createdById` equals.", "disabled": true }, { "key": "createdById[in]", "value": "njWQkGgk,njWQkGgk", "description": "Filter where `createdById` is one of (comma-separated list).", "disabled": true }, { "key": "labelId[eq]", "value": "xbUMIqgS", "description": "Filter where `labelId` equals.", "disabled": true }, { "key": "labelId[in]", "value": "xbUMIqgS", "description": "Filter where `labelId` is one of (comma-separated list).", "disabled": true }, { "key": "assigneeId[eq]", "value": "CNIgSuay", "description": "Filter where `assigneeId` equals.", "disabled": true }, { "key": "assigneeId[in]", "value": "CNIgSuay", "description": "Filter where `assigneeId` is one of (comma-separated list).", "disabled": true }, { "key": "subscriberId[eq]", "value": "NlUEieKe", "description": "Filter where `subscriberId` equals.", "disabled": true }, { "key": "subscriberId[in]", "value": "NlUEieKe", "description": "Filter where `subscriberId` is one of (comma-separated list).", "disabled": true }, { "key": "createdByActorId[eq]", "value": "49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` equals.", "disabled": true }, { "key": "createdByActorId[in]", "value": "49f861f7-4af8-44bf-844f-45f85babe504,49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "updatedByActorId[eq]", "value": "3306ed14-3606-4350-8300-2f06e6c80dce", "description": "Filter where `updatedByActorId` equals.", "disabled": true }, { "key": "updatedByActorId[in]", "value": "3306ed14-3606-4350-8300-2f06e6c80dce,3306ed14-3606-4350-8300-2f06e6c80dce", "description": "Filter where `updatedByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "startAt[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is greater than.", "disabled": true }, { "key": "startAt[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is greater than or equal to.", "disabled": true }, { "key": "startAt[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is less than.", "disabled": true }, { "key": "startAt[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is less than or equal to.", "disabled": true }, { "key": "dueAt[gt]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is greater than.", "disabled": true }, { "key": "dueAt[gte]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is greater than or equal to.", "disabled": true }, { "key": "dueAt[lt]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is less than.", "disabled": true }, { "key": "dueAt[lte]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is less than or equal to.", "disabled": true }, { "key": "completedAt[gt]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is greater than.", "disabled": true }, { "key": "completedAt[gte]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is greater than or equal to.", "disabled": true }, { "key": "completedAt[lt]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is less than.", "disabled": true }, { "key": "completedAt[lte]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is less than or equal to.", "disabled": true }, { "key": "archivedAt[gt]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is greater than.", "disabled": true }, { "key": "archivedAt[gte]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is greater than or equal to.", "disabled": true }, { "key": "archivedAt[lt]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is less than.", "disabled": true }, { "key": "archivedAt[lte]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "List tasks. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 22 fields. Ordered by `order` unless you pass `sort`.\n\n**Required scope:** `tasks:read`" } }, { "name": "Create Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"projectId\": \"iV6vIU8N\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks" ], "query": [ { "key": "expand", "value": "project,status", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Task. Server-assigned fields are ignored if sent.\n\n**Required scope:** `tasks:write`" } }, { "name": "Get Task", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "query": [ { "key": "expand", "value": "project,status", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Retrieve a single Task by id.\n\n**Required scope:** `tasks:read`" } }, { "name": "Update Task", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "query": [ { "key": "expand", "value": "project,status", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Partially update a Task. Only the fields you send are changed.\n\n**Required scope:** `tasks:write`" } }, { "name": "Delete Task", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Permanently delete this Task. This cannot be undone.\n\n**Required scope:** `tasks:delete`" } }, { "name": "Search Tasks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tasks/search", "host": [ "{{baseUrl}}" ], "path": [ "tasks", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "projectId", "value": "iV6vIU8N", "description": "The project to search within. Required — tasks are project-scoped and search has no workspace-wide mode.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "project,status", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "niceId[eq]", "value": "1234", "description": "Filter where `niceId` equals.", "disabled": true }, { "key": "niceId[in]", "value": "1234,1234", "description": "Filter where `niceId` is one of (comma-separated list).", "disabled": true }, { "key": "archived[eq]", "value": "false", "description": "Filter where `archived` equals.", "disabled": true }, { "key": "completed[eq]", "value": "false", "description": "Filter where `completed` equals.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "listId[eq]", "value": "lN6ZQycO", "description": "Filter where `listId` equals.", "disabled": true }, { "key": "listId[in]", "value": "lN6ZQycO,lN6ZQycO", "description": "Filter where `listId` is one of (comma-separated list).", "disabled": true }, { "key": "statusId[eq]", "value": "5aM4ncwI", "description": "Filter where `statusId` equals.", "disabled": true }, { "key": "statusId[in]", "value": "5aM4ncwI,5aM4ncwI", "description": "Filter where `statusId` is one of (comma-separated list).", "disabled": true }, { "key": "parentTaskId[eq]", "value": "4KOocqYo", "description": "Filter where `parentTaskId` equals.", "disabled": true }, { "key": "parentTaskId[in]", "value": "4KOocqYo,4KOocqYo", "description": "Filter where `parentTaskId` is one of (comma-separated list).", "disabled": true }, { "key": "dependencyId[eq]", "value": "i9TUmOWm", "description": "Filter where `dependencyId` equals.", "disabled": true }, { "key": "dependencyId[in]", "value": "i9TUmOWm,i9TUmOWm", "description": "Filter where `dependencyId` is one of (comma-separated list).", "disabled": true }, { "key": "recurringRuleId[eq]", "value": "cn2v0xiQ", "description": "Filter where `recurringRuleId` equals.", "disabled": true }, { "key": "recurringRuleId[in]", "value": "cn2v0xiQ,cn2v0xiQ", "description": "Filter where `recurringRuleId` is one of (comma-separated list).", "disabled": true }, { "key": "createdById[eq]", "value": "njWQkGgk", "description": "Filter where `createdById` equals.", "disabled": true }, { "key": "createdById[in]", "value": "njWQkGgk,njWQkGgk", "description": "Filter where `createdById` is one of (comma-separated list).", "disabled": true }, { "key": "labelId[eq]", "value": "xbUMIqgS", "description": "Filter where `labelId` equals.", "disabled": true }, { "key": "labelId[in]", "value": "xbUMIqgS", "description": "Filter where `labelId` is one of (comma-separated list).", "disabled": true }, { "key": "assigneeId[eq]", "value": "CNIgSuay", "description": "Filter where `assigneeId` equals.", "disabled": true }, { "key": "assigneeId[in]", "value": "CNIgSuay", "description": "Filter where `assigneeId` is one of (comma-separated list).", "disabled": true }, { "key": "subscriberId[eq]", "value": "NlUEieKe", "description": "Filter where `subscriberId` equals.", "disabled": true }, { "key": "subscriberId[in]", "value": "NlUEieKe", "description": "Filter where `subscriberId` is one of (comma-separated list).", "disabled": true }, { "key": "createdByActorId[eq]", "value": "49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` equals.", "disabled": true }, { "key": "createdByActorId[in]", "value": "49f861f7-4af8-44bf-844f-45f85babe504,49f861f7-4af8-44bf-844f-45f85babe504", "description": "Filter where `createdByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "updatedByActorId[eq]", "value": "3306ed14-3606-4350-8300-2f06e6c80dce", "description": "Filter where `updatedByActorId` equals.", "disabled": true }, { "key": "updatedByActorId[in]", "value": "3306ed14-3606-4350-8300-2f06e6c80dce,3306ed14-3606-4350-8300-2f06e6c80dce", "description": "Filter where `updatedByActorId` is one of (comma-separated list).", "disabled": true }, { "key": "startAt[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is greater than.", "disabled": true }, { "key": "startAt[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is greater than or equal to.", "disabled": true }, { "key": "startAt[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is less than.", "disabled": true }, { "key": "startAt[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `startAt` is less than or equal to.", "disabled": true }, { "key": "dueAt[gt]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is greater than.", "disabled": true }, { "key": "dueAt[gte]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is greater than or equal to.", "disabled": true }, { "key": "dueAt[lt]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is less than.", "disabled": true }, { "key": "dueAt[lte]", "value": "2026-06-07T12:00:00.000Z", "description": "Filter where `dueAt` is less than or equal to.", "disabled": true }, { "key": "completedAt[gt]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is greater than.", "disabled": true }, { "key": "completedAt[gte]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is greater than or equal to.", "disabled": true }, { "key": "completedAt[lt]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is less than.", "disabled": true }, { "key": "completedAt[lte]", "value": "2026-06-03T12:00:00.000Z", "description": "Filter where `completedAt` is less than or equal to.", "disabled": true }, { "key": "archivedAt[gt]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is greater than.", "disabled": true }, { "key": "archivedAt[gte]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is greater than or equal to.", "disabled": true }, { "key": "archivedAt[lt]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is less than.", "disabled": true }, { "key": "archivedAt[lte]", "value": "2026-06-05T12:00:00.000Z", "description": "Filter where `archivedAt` is less than or equal to.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true }, { "key": "updatedAt[gt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than.", "disabled": true }, { "key": "updatedAt[gte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is greater than or equal to.", "disabled": true }, { "key": "updatedAt[lt]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than.", "disabled": true }, { "key": "updatedAt[lte]", "value": "2026-05-31T14:00:00.000Z", "description": "Filter where `updatedAt` is less than or equal to.", "disabled": true } ] }, "description": "Full-text ranked search across tasks. Ranked by relevance; pages are capped at 200 results. Filterable by 22 fields.\n\n**Required scope:** `tasks:read`" } }, { "name": "Add assignees to a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/assignees", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "assignees" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Link the given ids to this Task as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Remove assignees from a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/assignees/remove", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "assignees", "remove" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Unlink the given ids from this Task's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Add labels to a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/labels", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "labels" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Link the given ids to this Task as labels. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Remove labels from a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"xbUMIqgS\",\n \"rXYsOME8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/labels/remove", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "labels", "remove" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Unlink the given ids from this Task's labels. Removing one that is not linked changes nothing. Returns the complete labels set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Add subscribers to a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/subscribers", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "subscribers" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Link the given ids to this Task as subscribers. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Remove subscribers from a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"P3hYIKqK\",\n \"nvgG0jMq\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/subscribers/remove", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "subscribers", "remove" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Unlink the given ids from this Task's subscribers. Removing one that is not linked changes nothing. Returns the complete subscribers set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Add hidden for to a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/hidden-for", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "hidden-for" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Link the given ids to this Task as hiddenFor. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Remove hidden for from a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"zngY4nUy\",\n \"50hcKom2\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/hidden-for/remove", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "hidden-for", "remove" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Unlink the given ids from this Task's hiddenFor. Removing one that is not linked changes nothing. Returns the complete hiddenFor set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Add connected tasks to a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"KfS0ha8P\",\n \"AfOKgoI8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/connected-tasks", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "connected-tasks" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Link the given ids to this Task as connectedTasks. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete connectedTasks set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Remove connected tasks from a Task", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"KfS0ha8P\",\n \"AfOKgoI8\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/connected-tasks/remove", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "connected-tasks", "remove" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Unlink the given ids from this Task's connectedTasks. Removing one that is not linked changes nothing. Returns the complete connectedTasks set afterwards.\n\n**Required scopes:** `tasks:write` `tasks:link`" } }, { "name": "Create tree (Task)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/create-tree", "host": [ "{{baseUrl}}" ], "path": [ "tasks", "create-tree" ] }, "description": "Create a task with its subtasks and their checklists in one atomic call — no id-threading, no half-built trees.\n\n**Required scope:** `tasks:write`" } }, { "name": "Attach document (Task)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"documentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/attach-document", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "attach-document" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Attach an existing document to this task (id = the task, documentId = the document; both must already exist in the same workspace). Idempotent — re-attaching is a no-op. Task assignees gain access to the document.\n\n**Required scope:** `tasks:write`" } }, { "name": "Detach document (Task)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"documentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/tasks/:id/detach-document", "host": [ "{{baseUrl}}" ], "path": [ "tasks", ":id", "detach-document" ], "variable": [ { "key": "id", "value": "KfS0ha8P", "description": "Id of the Task." } ] }, "description": "Detach a previously attached document from this task (id = the task, documentId = the document). Idempotent.\n\n**Required scope:** `tasks:write`" } } ] }, { "name": "Handoff", "item": [ { "name": "List Handoffs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/task-handoffs", "host": [ "{{baseUrl}}" ], "path": [ "task-handoffs" ], "query": [ { "key": "projectId", "value": "iV6vIU8N", "description": "Restrict the list to one project. Omit to list taskHandoffs across every project you can access.", "disabled": true }, { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`. Listing without `projectId` orders by `-updatedAt` instead.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "schema[eq]", "value": "nifty.checkpoint/1", "description": "Filter where `schema` equals.", "disabled": true }, { "key": "schema[in]", "value": "nifty.checkpoint/1,nifty.checkpoint/1", "description": "Filter where `schema` is one of (comma-separated list).", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List taskHandoffs. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 3 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `task-handoffs:read`" } }, { "name": "Create Handoff", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"taskId\": \"KfS0ha8P\",\n \"summary\": \"build → pass · next: open the PR against main\",\n \"body\": {\n \"schema\": \"nifty.checkpoint/1\",\n \"requirements\": {\n \"source\": \"card description\",\n \"acceptanceCriteria\": [\n \"the export downloads as CSV\"\n ]\n },\n \"invariantRegister\": [\n \"never write to the production replica\"\n ],\n \"decisions\": [\n {\n \"decision\": \"stream the CSV instead of buffering it\",\n \"reason\": \"exports above 50k rows ran out of memory\"\n }\n ],\n \"hypothesesEvaluated\": [\n {\n \"idea\": \"raise the worker memory limit\",\n \"result\": \"rejected — hides the bug at 100k rows\"\n }\n ],\n \"deltaState\": {\n \"filesModified\": [\n \"src/export/csv.service.ts\"\n ],\n \"checksRun\": [\n {\n \"cmd\": \"npm test -- csv\",\n \"revision\": \"a1b2c3d\",\n \"result\": \"12 passed\"\n }\n ]\n },\n \"openQuestions\": [\n \"should the export include archived rows?\"\n ],\n \"executionPointer\": {\n \"nextAction\": \"open the PR and request review\",\n \"blockedBy\": \"the streaming change must merge first\"\n },\n \"repos\": [\n {\n \"name\": \"api\",\n \"sha\": \"a1b2c3d\",\n \"branch\": \"feat/csv-export\",\n \"pushed\": true,\n \"dirty\": false\n }\n ],\n \"writer\": {\n \"tool\": \"claude-code\"\n },\n \"precededBy\": \"thNfB2k9\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/task-handoffs", "host": [ "{{baseUrl}}" ], "path": [ "task-handoffs" ], "query": [ { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Handoff. Server-assigned fields are ignored if sent.\n\n**Required scope:** `task-handoffs:write`" } }, { "name": "Get Handoff", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/task-handoffs/:id", "host": [ "{{baseUrl}}" ], "path": [ "task-handoffs", ":id" ], "query": [ { "key": "expand", "value": "task,createdByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "Ef8f2Vmq", "description": "Id of the Handoff." } ] }, "description": "Retrieve a single Handoff by id.\n\n**Required scope:** `task-handoffs:read`" } }, { "name": "Delete Handoff", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/task-handoffs/:id", "host": [ "{{baseUrl}}" ], "path": [ "task-handoffs", ":id" ], "variable": [ { "key": "id", "value": "Ef8f2Vmq", "description": "Id of the Handoff." } ] }, "description": "Permanently delete this Handoff. This cannot be undone.\n\n**Required scope:** `task-handoffs:delete`" } } ] }, { "name": "Time Entry", "item": [ { "name": "List Time Entries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/time-entries", "host": [ "{{baseUrl}}" ], "path": [ "time-entries" ], "query": [ { "key": "sort", "value": "start", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `start`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "member", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "manual[eq]", "value": "false", "description": "Filter where `manual` equals.", "disabled": true }, { "key": "start[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than.", "disabled": true }, { "key": "start[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than or equal to.", "disabled": true }, { "key": "start[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than.", "disabled": true }, { "key": "start[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than or equal to.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "memberId[eq]", "value": "P3hYIKqK", "description": "Filter where `memberId` equals.", "disabled": true }, { "key": "memberId[in]", "value": "P3hYIKqK,P3hYIKqK", "description": "Filter where `memberId` is one of (comma-separated list).", "disabled": true } ] }, "description": "List timeEntries. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 5 fields. Ordered by `start` unless you pass `sort`. Returns your own entries by default. With viewTimeReports on your role it returns every entry in your team instead; filter `memberId` for one person. This is the endpoint to build a team time report from — `search` stays scoped to your own entries regardless of role.\n\n**Required scope:** `time-entries:read`" } }, { "name": "Create Time Entry", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2026-06-01T12:00:00.000Z\",\n \"taskId\": \"KfS0ha8P\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/time-entries", "host": [ "{{baseUrl}}" ], "path": [ "time-entries" ], "query": [ { "key": "expand", "value": "member", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Time Entry. Server-assigned fields are ignored if sent.\n\n**Required scope:** `time-entries:write`" } }, { "name": "Get Time Entry", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/time-entries/:id", "host": [ "{{baseUrl}}" ], "path": [ "time-entries", ":id" ], "query": [ { "key": "expand", "value": "member", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "sfmueIsa", "description": "Id of the Time Entry." } ] }, "description": "Retrieve a single Time Entry by id. By default only your own entries are reachable here. With viewTimeReports on your role, so is any entry in your team — get widens exactly as list does, so a row you can see in list is a row you can fetch by id. Without that permission another member's entry is 404, not 403.\n\n**Required scope:** `time-entries:read`" } }, { "name": "Update Time Entry", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/time-entries/:id", "host": [ "{{baseUrl}}" ], "path": [ "time-entries", ":id" ], "query": [ { "key": "expand", "value": "member", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "sfmueIsa", "description": "Id of the Time Entry." } ] }, "description": "Partially update a Time Entry. Only the fields you send are changed.\n\n**Required scope:** `time-entries:write`" } }, { "name": "Delete Time Entry", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/time-entries/:id", "host": [ "{{baseUrl}}" ], "path": [ "time-entries", ":id" ], "variable": [ { "key": "id", "value": "sfmueIsa", "description": "Id of the Time Entry." } ] }, "description": "Permanently delete this Time Entry. This cannot be undone.\n\n**Required scope:** `time-entries:delete`" } }, { "name": "Search Time Entries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/time-entries/search", "host": [ "{{baseUrl}}" ], "path": [ "time-entries", "search" ], "query": [ { "key": "q", "value": "design", "description": "Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "member", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "manual[eq]", "value": "false", "description": "Filter where `manual` equals.", "disabled": true }, { "key": "start[gt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than.", "disabled": true }, { "key": "start[gte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is greater than or equal to.", "disabled": true }, { "key": "start[lt]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than.", "disabled": true }, { "key": "start[lte]", "value": "2026-06-01T12:00:00.000Z", "description": "Filter where `start` is less than or equal to.", "disabled": true }, { "key": "projectId[eq]", "value": "iV6vIU8N", "description": "Filter where `projectId` equals.", "disabled": true }, { "key": "projectId[in]", "value": "iV6vIU8N,iV6vIU8N", "description": "Filter where `projectId` is one of (comma-separated list).", "disabled": true }, { "key": "taskId[eq]", "value": "KfS0ha8P", "description": "Filter where `taskId` equals.", "disabled": true }, { "key": "taskId[in]", "value": "KfS0ha8P,KfS0ha8P", "description": "Filter where `taskId` is one of (comma-separated list).", "disabled": true }, { "key": "memberId[eq]", "value": "P3hYIKqK", "description": "Filter where `memberId` equals.", "disabled": true }, { "key": "memberId[in]", "value": "P3hYIKqK,P3hYIKqK", "description": "Filter where `memberId` is one of (comma-separated list).", "disabled": true } ] }, "description": "Full-text ranked search across timeEntries. Ranked by relevance; pages are capped at 200 results. Filterable by 5 fields. Always scoped to your own entries, whatever your role — unlike list and get, a reporting permission does NOT widen it. Do not build a team report from this endpoint; it will silently under-report.\n\n**Required scope:** `time-entries:read`" } } ] }, { "name": "Webhook", "item": [ { "name": "List Webhooks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [ { "key": "sort", "value": "-createdAt", "description": "Field to sort by. Prefix with `-` for descending (`-createdAt`); a `createdAt:desc` / `createdAt:asc` suffix works too, but never both markers at once. Default: `-createdAt`.", "disabled": true }, { "key": "cursor", "value": "", "description": "Opaque cursor for the next page (the envelope `nextCursor`).", "disabled": true }, { "key": "limit", "value": "", "description": "Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow `nextCursor` instead of assuming one page held everything.", "disabled": true }, { "key": "includeTotal", "value": "", "description": "When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.", "disabled": true }, { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true }, { "key": "purgeAt[null]", "value": "true", "description": "Filter where `purgeAt` is null (pass `true`).", "disabled": true }, { "key": "purgeAt[notNull]", "value": "true", "description": "Filter where `purgeAt` is not null (pass `true`).", "disabled": true }, { "key": "purgeAt[gt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than.", "disabled": true }, { "key": "purgeAt[gte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is greater than or equal to.", "disabled": true }, { "key": "purgeAt[lt]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than.", "disabled": true }, { "key": "purgeAt[lte]", "value": "2026-06-30T12:00:00.000Z", "description": "Filter where `purgeAt` is less than or equal to.", "disabled": true }, { "key": "name[eq]", "value": "Example", "description": "Filter where `name` equals.", "disabled": true }, { "key": "name[contains]", "value": "Example", "description": "Filter where `name` contains.", "disabled": true }, { "key": "name[startsWith]", "value": "Example", "description": "Filter where `name` starts with.", "disabled": true }, { "key": "active[eq]", "value": "true", "description": "Filter where `active` equals.", "disabled": true }, { "key": "createdAt[gt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than.", "disabled": true }, { "key": "createdAt[gte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is greater than or equal to.", "disabled": true }, { "key": "createdAt[lt]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than.", "disabled": true }, { "key": "createdAt[lte]", "value": "2026-05-31T12:00:00.000Z", "description": "Filter where `createdAt` is less than or equal to.", "disabled": true } ] }, "description": "List webhooks. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 4 fields. Ordered by `-createdAt` unless you pass `sort`.\n\n**Required scope:** `webhooks:read`" } }, { "name": "Create Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"Example\",\n \"url\": \"https://example.com/resource\",\n \"events\": [\n \"task.created\",\n \"task.updated\",\n \"project.*\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "webhooks" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ] }, "description": "Create a Webhook. Server-assigned fields are ignored if sent.\n\n**Required scope:** `webhooks:write`" } }, { "name": "Get Webhook", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Retrieve a single Webhook by id.\n\n**Required scope:** `webhooks:read`" } }, { "name": "Update Webhook", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "query": [ { "key": "expand", "value": "createdByActor,updatedByActor", "description": "Comma-separated relations to inline (see **Expanding objects** above). Valid values are listed in the enum.", "disabled": true } ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Partially update a Webhook. Only the fields you send are changed.\n\n**Required scope:** `webhooks:write`" } }, { "name": "Delete Webhook", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/webhooks/:id", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Move this Webhook to trash. It disappears from list results immediately and is permanently purged after a 30-day retention window; until then it can be restored.\n\n**Required scope:** `webhooks:delete`" } }, { "name": "Test (Webhook)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/:id/test", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Send a synthetic test event to this webhook's registered URL and report whether the endpoint accepted it. Use it to verify connectivity and signature verification before relying on live events.\n\n**Required scope:** `webhooks:write`" } }, { "name": "Rotate secret (Webhook)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhooks/:id/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "rotate-secret" ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Mint a new HMAC signing secret for this webhook and return it. The new secret is shown exactly once in this response — the previous secret stops verifying immediately.\n\n**Required scope:** `webhooks:write`" } }, { "name": "Deliveries (Webhook)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "deliveries" ], "query": [ { "key": "limit", "value": "100", "description": "How many delivery attempts to return, newest first. Between 1 and 100; defaults to 25.", "disabled": true } ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "List recent delivery attempts for this webhook, newest first — what was sent, whether the endpoint accepted it, and why it failed if it did not. Attempts are kept for 30 days.\n\n**Required scope:** `webhooks:read`" } }, { "name": "Restore Webhook", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Idempotency-Key", "value": "3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60", "description": "Optional replay key (see **Idempotent requests** above).", "disabled": true } ], "url": { "raw": "{{baseUrl}}/webhooks/:id/restore", "host": [ "{{baseUrl}}" ], "path": [ "webhooks", ":id", "restore" ], "variable": [ { "key": "id", "value": "GZiSa6Jk", "description": "Id of the Webhook." } ] }, "description": "Restore a Webhook that was deleted, returning it to list results. Restoring one that is already active succeeds and changes nothing.\n\n**Required scope:** `webhooks:delete`" } } ] } ] }