# List replicas

`GET https://api.cademi.com.br/api/v3/account/replicas`

Operation ID: `account.replicas.list` · API v3

Lists the replicas of the account associated with the current credentials, using cursor-based pagination.

Accounts that only share billing with the current account are not replicas and are not included.

Requires the `replicas.read` permission, which grants access to every replica of the account.

Required permissions: `replicas.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `limit` | query | integer | no |  |
| `cursor` | query | string | no |  |

## Responses

### 200

Returns a page of replicas.

Body: `data`: array of Replica.

Fields of Replica:

| Field | Type | Required | Description |
|---|---|---|---|
| `created_at` | string (date-time) | yes |  |
| `deleted` | boolean | yes |  |
| `id` | string | yes |  |
| `name` | string | yes |  |
| `object` | string, one of `replica` | yes | Object type. Always replica. |
| `status` | string, one of `initial`, `error`, `completed` | yes |  |
| `students_limit` | integer | yes | Maximum number of users allowed in the replica. |
| `subdomain` | string | yes |  |
| `subdomain_url` | string | yes |  |
| `sync_enabled` | boolean | yes | Whether replication to this replica is enabled. |

### 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