---
title: "General recording information"
method: GET
path: "/recording/{recording_id}/"
tags: ["recording"]
---

# General recording information

`GET /recording/{recording_id}/`

## Request

- Base URL: `https://api.angelcam.com/v1`
- URL: `https://api.angelcam.com/v1/recording/{recording_id}/`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://my.angelcam.com/oauth/authorize/`, token URL `https://my.angelcam.com/oauth/token/`
    - Password, token URL `https://api.angelcam.com/oauth/token/`
    - Scopes: `recording_access`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/angelcam/apis/angelcam-api/docs/recording/:recording_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `recording_id` string, uuid, required

## Response `200`

Returns general recording information.

- RecordingResponse
  - `id` string, uuid, required: Recording ID
  - `status` 'READY' | 'CONNECTING' | 'RECORDING' | 'STOPPING' | 'ERROR', required: Recording status values have the following meaning: * `READY` - Not recording (recording is ready to be started) * `CONNECTING` - Recorder is trying to connect to the stream (this usually indicates camera connectivity problems; the recorder keeps trying to connect). * `RECORDING` - Recorder is connected to the stream and records are being created * `STOPPING` - Recording is stopping * `ERROR` - Error occurred when recording (this indicates a possible issue with Angelcam infrastructure)
  - `retention` string, nullable, required: Retention period in ISO 8601 duration format tells how long in past we store the footage. Example: P7D means 7 days.
  - `record_queue_capacity` number, nullable: Capacity of the record queue in seconds, maxium amount of seconds to be recorded in total, unlimited if null
  - `deactivated_at` string, datetime, nullable, required: Datetime when recording service has been deactivated, if null then recording is active.
  - `recording_start` string, datetime, nullable: Recording footage start datetime, if null there is no recording footage
  - `recording_end` string, datetime, nullable: Recording footage end datetime, if null there is no recording footage

## Other responses

- `401`: Missing or invalid authorization.
- `403`: Missing permission.
- `404`: The specified resource was not found

---

[API](https://skmtc.dev/angelcam/apis/angelcam-api.md) - [All operations](https://skmtc.dev/angelcam/apis/angelcam-api/llms.txt) - [OpenAPI document](https://skmtc.dev/angelcam/apis/angelcam-api/revisions/dd1cdc3f2c23?raw)
