# Recordings API

> Reference for the 2 public v1 operations of the Recordings API, generated from the OpenAPI spec.

Source: https://docs.nexafone.so/v1/api/recordings/

Generated from `api/openapi.public.yaml`, the same spec the API serves. Try these operations in the [API console](/v1/api/console/); errors are [Problem Details](/v1/errors/).

## List the call audio library

`GET /api/v1/workspaces/{workspaceId}/recordings`

Recordings that a team's settings play are listed only for that team's members, Owner and Admin.

| | |
| --- | --- |
| Operation id | `listRecordings` |
| Authentication | A secret key (`sk_live_…` or `sk_test_…`), an SDK session token (`sdk_…`), or a secret partner key for one of the partner’s stores. |
| Permission (key scope) | `recordings:view` |
| Plan feature | `recordings.library` |

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `workspaceId` | path | string | yes | Workspace id (UUID) |
| `kind` | query | `"greeting"` \| `"option"` \| `"fallback_closed"` \| `"fallback_prayer"` \| `"fallback_missed"` \| `"hold"` \| `"custom"` |  | Only recordings of this kind |
| `language` | query | `"en"` \| `"so"` \| `"ar"` |  | Only recordings in this language |

### Responses

| Status | Description | Body |
| --- | --- | --- |
| 200 | OK | `application/json`: [ListOutputBody](/v1/api/schemas/#listoutputbody) |
| default | Error | `application/problem+json`: [Problem](/v1/api/schemas/#problem) |

### Example

```bash
curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/recordings" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"
```

## Get a recording

`GET /api/v1/workspaces/{workspaceId}/recordings/{recordingId}`

| | |
| --- | --- |
| Operation id | `getRecording` |
| Authentication | A secret key (`sk_live_…` or `sk_test_…`), an SDK session token (`sdk_…`), or a secret partner key for one of the partner’s stores. |
| Permission (key scope) | `recordings:view` |
| Plan feature | `recordings.library` |

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `workspaceId` | path | string | yes | Workspace id (UUID) |
| `recordingId` | path | string | yes | Recording id (UUID) |

### Responses

| Status | Description | Body |
| --- | --- | --- |
| 200 | OK | `application/json`: [RecordingBody](/v1/api/schemas/#recordingbody) |
| 404 | Not Found | `application/problem+json`: [Problem](/v1/api/schemas/#problem) |
| 422 | Unprocessable Entity | `application/problem+json`: [Problem](/v1/api/schemas/#problem) |
| 500 | Internal Server Error | `application/problem+json`: [Problem](/v1/api/schemas/#problem) |

### Example

```bash
curl -X GET "https://api.nexafone.so/api/v1/workspaces/{workspaceId}/recordings/{recordingId}" \
  -H "Authorization: Bearer $NEXAFON_SECRET_KEY"
```