Skip to main content
GET
/
v1
/
recordings
cURL
curl --request GET \
  --url https://api.claap.io/v1/recordings \
  --header 'X-Claap-Key: <api-key>'
{
  "result": {
    "recordings": [
      {
        "channel": {
          "id": "<string>",
          "name": "<string>"
        },
        "createdAt": "<string>",
        "durationSeconds": 123,
        "id": "<string>",
        "labels": [
          "<string>"
        ],
        "meeting": {
          "endingAt": "<string>",
          "participants": [
            {
              "attended": true,
              "email": "<string>",
              "id": "<string>",
              "name": "<string>"
            }
          ],
          "startingAt": "<string>",
          "type": "internal"
        },
        "recorder": {
          "attended": true,
          "email": "<string>",
          "id": "<string>",
          "name": "<string>"
        },
        "state": "<string>",
        "thumbnailUrl": "<string>",
        "title": "<string>",
        "transcripts": [
          {
            "isActive": true,
            "isTranscript": true,
            "langIso2": "<string>",
            "textUrl": "<string>",
            "url": "<string>"
          }
        ],
        "url": "<string>",
        "video": {
          "url": "<string>"
        },
        "workspace": {
          "id": "<string>",
          "name": "<string>"
        }
      }
    ],
    "pagination": {
      "nextCursor": "<string>",
      "totalCount": 123
    }
  }
}

Authorizations

​
X-Claap-Key
string
header
required

Query Parameters

​
channelId
string

Discard recordings not belonging to this channel.

​
createdAfter
string

Discard recordings created before specified time.

​
createdBefore
string

Discard recordings created after specified time.

​
cursor
string

Paginate the results starting at the cursor returned by a previous call.

​
labels
string

A collection of comma-separated label names. Discard recordings matching none of the specified labels. Labels can only be used when filtering by channel.

​
limit
number
default:20

Return at most "limit" results.

Required range: 1 <= x <= 100
​
recorderEmail
string

Discard recordings which recorder email does not match specified one.

​
recorderId
string

Discard recordings which recorder identifier does not match specified one.

​
sort
enum<string>
default:created_desc

Sort results according to specified rule.

Available options:
created_asc,
created_desc,
duration_asc,
duration_desc,
title_asc,
title_desc

Response

200 - application/json

Recordings were successfully retrieved

​
result
object
required