# List users

`GET https://api.cademi.com.br/api/v3/users`

Operation ID: `users.list` · API v3

Returns the users of the account, using cursor-based pagination.

The collection can be filtered by a search term matched against name and email (`q`), by `external_id`, and by tag (`tag_id[]`, which matches users with any of the given tags). Users in the trash are excluded by default; set `deleted=true` to list only users in the trash.

The `document` and `phone` fields are returned only when the credentials have the `users.read_personal` permission.

Required permissions: `users.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `q` | query | string | no |  |
| `external_id` | query | string | no |  |
| `deleted` | query | boolean | no |  |
| `tag_id[]` | query | array of string | no |  |

## Responses

### 200

Returns a page of users.

Body: `data`: array of User.

Fields of User:

| Field | Type | Required | Description |
|---|---|---|---|
| `access` | string, one of `granted`, `none` | yes |  |
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `document` | string or null | no |  |
| `email` | string (email) | yes |  |
| `external_id` | string or null | no |  |
| `id` | string | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `user` | yes |  |
| `phone` | string or null | no |  |
| `revision` | string | yes |  |
| `status` | string, one of `active`, `inactive` | yes |  |
| `tags` | array of string | yes |  |
| `updated_at` | string (date-time) | yes |  |

### 400

The cursor is invalid or the request contains an unsupported query parameter.

Body: Error.

### 401

The credential is missing, malformed, expired, or revoked.

Body: Error.

### 403

The current credentials do not have the permission required by this operation.

Body: Error.

### 422

The request body or query parameters failed validation.

Body: ValidationFailed.

Full schema: https://cademi.dev/openapi/v3.json