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

# List users

`GET /api/users`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/users`
- Auth: API key in header `x-token`
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns all non-archived users for the API key's company.

## Response `200`

List of users.

- object
  - `data` object[]
    - `_id` string: User ID.
    - `name` string: Full name (firstname + lastname).
    - `role` string, nullable: Role name, or null if the role has been deleted.

## Other responses

- `401`: Invalid or missing API key.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)