---
title: "Retrieve a list of users"
method: GET
path: "/v1/users"
tags: ["Users"]
---

# Retrieve a list of users

`GET /v1/users`

Returns a paginated list of users in your organization with their profile, license, and integration status.

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `licenseAdded` boolean
- `role` 'VIEWER' | 'EDITOR' | 'ORGANIZATION_ADMIN' | 'USER_ADMIN' | 'USER'

## Response `200`

A paginated list of users.

- object
  - `users` User[], required
    - `email` string, email, required — User's email address
    - `name` string, required — User's full name
    - `role` 'viewer' | 'editor' | 'organization-admin' | 'user-admin' | 'user', required — User's role in the organization. Note: the role filter query parameter accepts uppercase values (e.g. VIEWER), but the response returns the stored lowercase form.
    - `type` string, required — User type
    - `slackUserId` string, nullable — User's Slack user ID, if connected
    - `title` string, nullable — User's job title from Slack profile
    - `salesforceDepartment` string, nullable — User's department from Salesforce
    - `salesforceUserRole` string, nullable — User's role name from Salesforce
    - `licenseAdded` boolean, required — Whether the user has an active AI license
    - `licenseAssignedAt` string, date-time, nullable — Timestamp when the license was assigned
    - `salesforceAuthStatus` 'AUTHENTICATED' | 'NOT_AUTHENTICATED', required — Salesforce authentication status
    - `gcalAuthStatus` 'AUTHENTICATED' | 'NOT_AUTHENTICATED', required — Google Calendar authentication status
  - `pageCount` integer, required — Total number of pages available for the current query.

## Other responses

- `400` — Bad request due to validation errors
- `500` — Internal server error

---

[API](https://skmtc.net/momentum/apis/momentum-api.md) · [All operations](https://skmtc.net/momentum/apis/momentum-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/momentum/momentum-api/revisions/7c9ae2273788/schema)