Enhance documentation
enhance-dev canvas participants list
List people with direct access to a canvas.
enhance-dev canvas participants list
enhance-dev canvas participants list [options]Arguments
This command takes no positional arguments.
Options
| Option | Required | Default | Meaning |
|---|---|---|---|
--canvas-id <string> | Yes | None | Canvas id, from enhance canvas list. |
--json <json> | No | None | Complete procedure input as JSON; do not combine it with field flags. |
Input
This command presents the capability canvas.participants.list. It has read effect and none idempotency.
Show complete input JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["canvasId"]}Output
This command writes JSON records to standard output. Returns a typed canvas.participants.list result from the Enhance API without transport-specific prose.
Show complete output JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"personId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"email":{"anyOf":[{"type":"string","maxLength":254},{"type":"null"}]},"displayName":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"initials":{"anyOf":[{"type":"string","maxLength":4},{"type":"null"}]},"avatarUrl":{"anyOf":[{"type":"string","maxLength":2048},{"type":"null"}]},"accessLevel":{"type":"string","enum":["owner","can-edit","can-comment","can-view"]},"isPending":{"type":"boolean"},"reviewState":{"anyOf":[{"type":"string","enum":["not-started","in-progress","done"]},{"type":"null"}]},"lastViewedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},{"type":"null"}]}},"required":["personId","email","displayName","initials","avatarUrl","accessLevel","isPending","reviewState","lastViewedAt"],"additionalProperties":false}},"truncated":{"type":"boolean"}},"required":["items","truncated"],"additionalProperties":false}Examples
enhance-dev canvas participants list --canvas-id <string>Show example input
{
"canvasId": "00000000-0000-4000-8000-000000000010"
}Show example output
{
"items": [],
"truncated": false
}Exit behaviour
| Exit code | Meaning |
|---|---|
0 | The command succeeded. |
1 | The command failed for another reason (INTERNAL). A write may have an unknown outcome. |
2 | The command line was malformed. Nothing ran. |
3 | The API refused the input (BAD_REQUEST). |
4 | The credential is missing or expired (UNAUTHORIZED). |
5 | The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED). |
6 | A batch finished only in part. Retry with the same --client-token. |
Versions
Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.