---
title: "List users"
method: GET
path: "/users"
tags: ["users"]
---

# List users

`GET /users`

Gets a list of users

## Query parameters

- `email` string
- `search` string
- `sortField` 'email' | 'name' | 'id' | 'idp' | 'idp_ref' | 'created_at' | 'updated_at' | 'last_seen_at' | 'dashboard'
- `sortDirection` 'asc' | 'desc' — Sort direction - asc (ascending) or desc (descending)
- `pageSize` integer
- `pageNumber` integer

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Response `200`

Response with status 200

- TypeUsersListUsersResponse
  - `data` TypeUsersUser[], required
    - `email` string, required
    - `name` string, required
    - `accountId` string, required — Account ID
    - `id` string, required — User ID
    - `idp` string, required
    - `idpRef` string
    - `metadata` object, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `lastSeenAt` string, date-time
    - `dashboard` integer
  - `pagination` TypeCommonsPagination — pagination info
    - `currentPage` integer, required — current page of results
    - `pageCount` integer, required — total number of pages of results
    - `totalCount` integer, required — total available results

---

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