Document collaboration

Find teammates who can read this discussion

GET
/v1/documents/{documentId}/mention-candidates

Authorization

bearerAuth
AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Path Parameters

documentId*string

The documentId.

Query Parameters

query?string

Name or email fragment.

discussionPlanId?string

The plan using this document.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/string/mention-candidates"
{  "candidates": [    {      "membershipId": "string",      "userId": "string",      "label": "string",      "email": "string"    }  ]}