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

# List users

`GET /iam/v1/users`

Returns a list of users in the organization, including both active users and invited users.
When the `email` query parameter is provided, returns only the user matching that email address.
If no user is found for the given email, an empty list is returned.

## Query parameters

- `email` string, email

## Response `200`

OK - List of users returned.

- ListUsersResponseBody — Response body for the list users endpoint.
  - `users` UserListItem[]
    - `id` string — The unique ID of the user.
    - `email` string — The email address of the user.
    - `displayName` string — The user's display name.
    - `firstName` string — The user's first name.
    - `lastName` string — The user's last name.
    - `jobTitle` 'Data Engineer / Data Analysts' | 'Executive Team' | 'Finance / Accounting' | 'Founder' | 'Legal / Purchasing' | 'Management' | 'Sales / Marketing' | 'Software / Ops Engineer' — The user's job function.
    - `phone` string — The user's country code (e.g., +44).
    - `phoneExtension` string — The user's phone extension.
    - `language` 'en' | 'ja' — The user's preferred language.
    - `roleId` string — The ID of the user's role.
    - `organizationId` string — The ID of the user's organization.
    - `status` 'active' | 'invited' — The status of the user (active or invited).
  - `rowCount` integer — The number of returned records.

## Other responses

- `400` — Bad Request - The server cannot process the request, often due to a malformed request.
- `401` — Unauthorized - Invalid API key.
- `403` — Forbidden - The client is not authorized to perform the request.
- `500` — Internal Server Error - Something went wrong with the DoiT API server.

---

[API](https://skmtc.dev/doit/apis/doit-cloud-intelligence.md) · [All operations](https://skmtc.dev/doit/apis/doit-cloud-intelligence/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/doit/doit-cloud-intelligence/revisions/9416402fc119/schema)