---
title: "Get document users"
method: GET
path: "/v2/documents/{document_id}/roles"
---

# Get document users

`GET /v2/documents/{document_id}/roles`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/documents/{document_id}/roles`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/documents/:document_id/roles/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows API users to retrieve a paginated list of users who have access to the document, including their emails, roles, names, and avatars.

**Notes**

* The owner sees all users with roles (including themselves as `owner`).
* A non-owner (shared user) sees only the owner and themselves.

## Response `200`

Success. Returns a paginated list of users with access to the document.

- object
  - `data` object[]: Roles in the document.
    - `id` string: Unique identifier of the user.
    - `role` string: User's role in the document (`owner`, `viewer`, or `sender`).
    - `email` string: Email address of the user.
    - `full_name` string: Full name of the user.
    - `avatar_url` string: URL of the user's avatar image.
  - `meta` object: Pagination details.
    - `pagination` object: Pagination details for the response.
      - `count` integer: Number of items on the current page.
      - `links` object: Links to the adjacent pages. An empty array if there are no other pages.
        - `next` string: URL of the next page. Returned only if there is a next page.
        - `previous` string: URL of the previous page. Returned only if there is a previous page.
      - `total` integer: Total number of items.
      - `per_page` integer: Maximum number of items per page.
      - `total_pages` integer: Total number of pages.
      - `current_page` integer: Number of the current page.

## Other responses

- `400`: * Wrong, expired, or missing token. * Document not found. * You don't have access to the entity.

---

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