---
title: "List Users"
method: GET
path: "/v1/accounts/{account_id}/users"
tags: ["Users"]
---

# List Users

`GET /v1/accounts/{account_id}/users`

**Authorization scope:** `user:list` 
 
 **List users**

## Path parameters

- `account_id` string, required

## Query parameters

- `email` string, nullable — Query parameter for filtering by email
- `name` string, nullable — Query parameter for filtering name in email or user name
- `team_id` string[], nullable — Query parameter for filtering by team id
- `page` integer
- `items_per_page` integer
- `sort_by` 'user_name' | 'created_at' | 'last_login' | 'user_email' | 'invited_by' | 'is_admin' | 'source' — User sort properties in the UI.
- `sort_order` 'desc' | 'asc' — Sorting can be either asc or desc, used in the api-service

## Response `200`

Successful Response

- ListUsersResponse — List users response
  - `next_page` string, nullable — The next page URL
  - `previous_page` string, nullable — The previous page URL
  - `page` integer — The page number
  - `current_page_size` integer, required — The current page size
  - `total_items` integer — The total number of entities fetched
  - `account_id` string, required — The account id
  - `items` ListUserModel[], required
    - `user_id` string, required — The user id
    - `user_email` string, required — The email of the user
    - `user_name` string, required — The user name
    - `environments` object, required — The user environments and permission
    - `is_admin` boolean, required — A flag that indicates whether the flag is admin
    - `is_global_operator` boolean — Indicates if the user is a global operator (read-only cross-account)
    - `status` string, required — The user status
    - `created_at` string, date-time, nullable — The user creation date
    - `last_login` string, date-time, nullable — The user's last login date
    - `updated_at` string, date-time, nullable — The user last update date
    - `groups` string[] — The user's groups
    - `source` string, required — The user source
    - `invited_by` string, nullable — The user who invited this user
    - `is_active` boolean, nullable — Indicates if the user is active
    - `onboarding` UserOnboardingModel — Onboarding steps model
      - `know_rivery_step` object, nullable — User finished first step
      - `data_connections_step` object, nullable — User finished second step
      - `data_pipeline_step` object, nullable — User finished third step
      - `transform_and_orchestrate_step` object, nullable — User finished fourth step
      - `pre_built_solutions_step` object, nullable — User finished fifth step
      - `invite_member_step` object, nullable — User finished sixth step

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/rivery/apis/boomi-data-integration-api.md) · [All operations](https://skmtc.net/rivery/apis/boomi-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivery/boomi-data-integration-api/revisions/9dfc2be2007f/schema)