# Retrieve a replica

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

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

Retrieves a replica of the current account by its public ID.

Only replicas of the account associated with the current credentials can be retrieved. Accounts that only share billing with the current account are not replicas. Any other ID, including the current account's own, returns `404 Not Found`.

Required permissions: `replicas.read`.

## Parameters

| Name | In | Type | Required | Description |
|---|---|---|---|---|
| `replica_id` | path | string | yes |  |

## Responses

### 200

Returns the requested replica.

Body: `data`: 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. |

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

### 404

The replica was not found or is not accessible with the current credentials.

Body: Error.

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