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

# List users

`GET /admin/users`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/admin/users`
- Auth: API key in header `x-speakai-key` and API key in header `x-access-token`

## Get Users

This endpoint retrieves a list of users from the admin panel. It is primarily used by administrators to access user information stored in the system.

### Request

- **Method**: GET

- **Endpoint**: `{{url}}/v1/admin/users`


### Response

The response will contain a JSON object with the following structure:

- **users**: An array of user objects, where each user object includes:

 - **id**: Unique identifier for the user.

 - **name**: The name of the user.

 - **email**: The email address of the user.

 - **role**: The role assigned to the user (e.g., admin, user).

 - **status**: The current status of the user (e.g., active, inactive).


### Example Response

``` json
{
 "users": [
 {
 "id": "123",
 "name": "John Doe",
 "email": "john.doe@example.com",
 "role": "admin",
 "status": "active"
 },
 {
 "id": "124",
 "name": "Jane Smith",
 "email": "jane.smith@example.com",
 "role": "user",
 "status": "inactive"
 }
 ]
}

 ```

### Notes

- Ensure that appropriate authentication and authorization headers are included in the request to access this endpoint.

- The response may vary based on the user's permissions and the number of users in the system.

## Response `200`

Success

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)