Get a Recording

In order to retrieve a recording metadata, you can use the following endpoint.

Get recording

get

Get recording

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstringRequired

recordingIdstringRequired

Responses

200

The recording metadata

application/json

idstring · uuidRequired

The ID for the recording.

sourcestring · enumRequiredPossible values:

sourceIdstring · uuidRequired

The ID for the source.

channelIdstring · uuidOptional

The ID for the channel.

statusstring · enumRequiredPossible values:

directionstring · enumOptionalPossible values:

originstring · enumRequiredPossible values:

durationinteger · int64Optional

stereobooleanRequired

formatstringRequired

transcriptionbooleanRequired

conferenceIdstring · uuidOptional

The ID for the conference.

urlstringOptional

roomInfoUrlstringOptional

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

endedAtstring · date-timeOptional

startedAtstring · date-timeOptional

307

The recording file

404

Not found

application/json

422

Unprocessable Entity

application/json

get

/workspaces/{workspaceId}/recordings/{recordingId}

HTTPcURLJavaScriptPython

GET /workspaces/{workspaceId}/recordings/{recordingId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "source": "call",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "accepted",
  "direction": "incoming",
  "originator": {
    "contact": {
      "id": "text",
      "identifierKey": "text",
      "identifierValue": "text"
    },
    "number": {
      "type": "pstn",
      "number": "text",
      "anonymous": true,
      "callerIdName": "text",
      "identity": "text",
      "countryIsoCode": "text"
    }
  },
  "receiver": {
    "contact": {
      "id": "text",
      "identifierKey": "text",
      "identifierValue": "text"
    },
    "number": {
      "type": "pstn",
      "number": "text",
      "anonymous": true,
      "callerIdName": "text",
      "identity": "text",
      "countryIsoCode": "text"
    }
  },
  "origin": "call-command-record",
  "duration": 1,
  "stereo": true,
  "format": "text",
  "transcription": true,
  "conferenceId": "123e4567-e89b-12d3-a456-426614174000",
  "url": "text",
  "roomInfoUrl": "text",
  "createdAt": "2026-03-06T20:00:54.088Z",
  "updatedAt": "2026-03-06T20:00:54.088Z",
  "endedAt": "2026-03-06T20:00:54.088Z",
  "startedAt": "2026-03-06T20:00:54.088Z"
}

Request

curl "/workspaces/{workspaceId}/recordings/{recordingId}" \
     -H 'Authorization: AccessKey YOUR_SECRET_TOKEN'

Response

In order to directly retrieve the recording media, you must add the extension .mp3 to the above request.

/workspaces/{workspaceId}/recordings/{recordingId}.mp3

If successful, the above request will return a "307 Temporary Redirect” with the recording file.