---
title: "Get Users"
method: POST
path: "/users/get"
tags: ["Users"]
---

# Get Users

`POST /users/get`

## Request

- Base URL: `https://api.velt.dev/v2`
- URL: `https://api.velt.dev/v2/users/get`
- Auth: API key in header `x-velt-api-key` and API key in header `x-velt-auth-token`

Use this API to retrieve users based on various filters such as organization ID, document ID, folder ID, organization user group IDs or user IDs.

**Requirements:**
- Enable advanced queries option in the Velt Console
- Deploy v4 series of the Velt SDK

## Request body

- object
  - `data` object, required
    - `organizationId` string, required: Organization ID
    - `documentId` string: Document ID
    - `folderId` string: Folder ID
    - `userIds` string[]: Array of User IDs (max 30)
    - `organizationUserGroupIds` string[]: Array of Organization User Group IDs (max 30)
    - `allDocuments` boolean: If true, retrieves all document users within the organization
    - `groupByDocumentId` boolean: If true, response is grouped by document ID (works with allDocuments)
    - `pageSize` integer: Number of items per page
    - `pageToken` string: Page token from previous API call

## Response `200`

Users retrieved successfully

- object
  - `result` object
    - `status` string
    - `message` string
    - `data` union
      - User[]
        - `userId` string, required: Unique identifier for the user
        - `name` string, required: Display name of the user
        - `email` string, email, required: Email address of the user
        - `accessRole` 'viewer' | 'editor': Access role for the resource (viewer for read-only, editor for read/write)
        - `initial` string: User initials (auto-generated from name if not provided)
      - object
    - `nextPageToken` string

## Other responses

- `400`: Invalid request

---

[API](https://skmtc.dev/velt-js/apis/velt-rest-api.md) - [All operations](https://skmtc.dev/velt-js/apis/velt-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/velt-js/apis/velt-rest-api/revisions/0f5af15fa267?raw)