# List enrollments

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

Operation ID: `enrollments.list` · API v3

Lists enrollments across all users in the account.

At least one of `user_id`, `product_id`, `delivery_id`, or `updated_after` must be supplied; requests without any of these filters are rejected with a validation error. Revoked enrollments are excluded unless `status=revoked` or `deleted=true` is supplied.

Each item includes a `links.self` URL pointing to the enrollment under its user.

Required permissions: `enrollments.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |
| `user_id` | query | string | no |  |
| `product_id` | query | string | no |  |
| `delivery_id` | query | string | no |  |
| `status` | query | string, one of `active`, `suspended`, `revoked` | no |  |
| `origin` | query | string, one of `manual`, `sale`, `subscription` | no |  |
| `deleted` | query | boolean | no |  |
| `updated_after` | query | string (date-time) | no |  |

## Responses

### 200

Returns a page of enrollments.

Body: `data`: array of Enrollment.

Fields of Enrollment:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | no |  |
| `deleted` | boolean | yes |  |
| `delivery_id` | string | yes |  |
| `ends_at` | string or null (date-time) | no |  |
| `id` | string | yes |  |
| `object` | string, one of `enrollment` | yes |  |
| `origin` | object | yes |  |
| `product_ids` | array of string | yes |  |
| `revision` | string | yes |  |
| `status` | string, one of `active`, `suspended`, `revoked` | yes |  |
| `subscription_ends_at` | string or null (date-time) | no |  |
| `updated_at` | string (date-time) | no |  |
| `user_id` | string | 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
