---
title: "List collaborators"
method: POST
path: "/api/v1/list_collaborators"
---

# List collaborators

`POST /api/v1/list_collaborators`

## Request

- Base URL: `https://offprint.io`
- URL: `https://offprint.io/api/v1/list_collaborators`
- Auth: HTTP bearer

List a document's members and their roles (owner, editor, commenter, viewer).

## Request body

- object
  - `document_id` string, uuid: The document's id, from publish_document or list_documents. Pass this or slug.
  - `slug` string: The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.

## Response `200`

Success.

- object
  - `members` object[], required
    - `handle` string, required
    - `role` 'owner' | 'editor' | 'commenter' | 'viewer', required: Your role on the document or project.

## Other responses

- `400`: Invalid arguments.
- `401`: Missing, expired or revoked API key.
- `403`: The key's scope, restriction or role does not allow this.
- `404`: Not found, or outside the key's restriction.
- `409`: The document changed since expected_revision.
- `429`: A plan limit or daily quota was reached.

---

[API](https://skmtc.dev/offprint/apis/offprint-api.md) · [All operations](https://skmtc.dev/offprint/apis/offprint-api/llms.txt) · [OpenAPI document](https://skmtc.dev/offprint/apis/offprint-api/revisions/d50a825280d2?raw)