enhancedocs
For agentsOpen Enhance ↗
Reference / canvas.participants.list

Enhance documentation

canvas.participants.list

List people with direct access to a canvas.

↓ Markdown

canvas.participants.list

query read

Use when current canvas state is missing from the task context.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

Show complete 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"]}

Example

Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}

Result

Returns a typed canvas.participants.list result from the Enhance API without transport-specific prose.

  • items (required): Returned field items.
  • truncated (required): Returned field truncated.
Show complete result 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}

Example result

Show example result 
{
 "items": [],
 "truncated": false
}

Recovery

  • BAD_REQUEST: correct the named fields and call again.
  • UNAUTHORIZED: restore Enhance authentication, then retry once.
  • FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
  • CONFLICT: read the current resource, merge the intended change, and retry with its version.
  • INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

  • Choose an id from the result before another canvas operation.

Versions

Compatibility: c2a3b4823ee1af62d770a0a2a254445989350e9f5c5495a0f283056d20f27174.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.