---
title: "Gets all users in an account."
method: GET
path: "/users"
tags: ["Users"]
---

# Gets all users in an account.

`GET /users`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/users`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://id.reveldigital.com/connect/authorize`
    - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
  - API key in header `X-RevelDigital-ApiKey`
  - API key in query parameter `api_key`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `id` string
- `take` integer
- `page` integer

## Response `200`

Returns an array of users

- User[]
  - `id` string, nullable: The user id
  - `first_name` string, nullable: The first name
  - `last_name` string, nullable: The last name
  - `city` string, nullable: The city
  - `state` string, nullable: The state
  - `postal_code` string, nullable: The postal code
  - `country` string, nullable: The country
  - `home_phone` string, nullable: The home phone number
  - `work_phone` string, nullable: The work phone number
  - `mobile_phone` string, nullable: The mobile phone number
  - `created_on` string, date-time, nullable: The date the user was created
  - `email` string, nullable: The email address
  - `role` string[], nullable: The roles assigned to this user
  - `user_name` string, nullable: The username
  - `last_activity` string, date-time, nullable: The date the user last logged in
  - `email_alerts` boolean, nullable: Whether the user has email alerts enabled
  - `sms_alerts` boolean, nullable: Whether the user has SMS alerts enabled
  - `is_two_factor` boolean, nullable: Whether the user has two-factor authentication enabled

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)