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

# List users

`GET /user`

List all users in your organization.

## Query parameters

- `organization_id` string, required
- `email` string
- `first_name` string
- `last_name` string
- `status` 'active' | 'inactive' | 'pending' | 'invited'
- `id` string
- `type` 'machine' | 'person'
- `offset` integer
- `limit` integer

## Response `200`

The list of users matching the query.

- UserListResponse
  - `paging` object, required
    - `offset` integer, required — The start of the paging window. Minimum is 0.
    - `limit` integer, required — Maximum number of elements to retrieve per call. Maximum is 200.
  - `results` UserResponse[], required
    - `id` integer, required — The ID of the user.
    - `email` string, required — The email of the user.
    - `first_name` string, nullable, required — The first name of the user.
    - `last_name` string, nullable, required — The last name of the user.
    - `organization_id` integer, required — The organization ID of the user.
    - `status` 'active' | 'inactive' | 'pending' | 'invited' — The status of the user.
    - `avatar` string, nullable — The avatar of the user.
    - `type` 'person' | 'machine' — The type of the user.
    - `provider` 'cognito' | 'saml', nullable — The authentication provider of the user.
    - `nrn` string, required — The NRN of the user.
    - `send_invite` boolean — Whether to send an invite email to the user.
    - `metadata` object — The metadata of the user.

## Other responses

- `4XX` — Client error responses due to invalid input or missing parameters.
- `5XX` — Server error responses indicating an issue on the API side.

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)