List Recordings

This is the method to get a list a recordings, you can query them with some parameters.

Last updated 3 days ago

Retrieve a list of videos

get

Returns a paginated list of video objects. Optional filters include: ticket, email, and a custom metadata filter using param and value.

Authorizations

Query parameters

ticketstringOptional

Filter videos by ticket id.

emailstringOptional

Filter videos by customer email (recorded_by).

paramstringOptional

Filter videos by metadata key (only when you added those params with the recording link type /urec/helpdesk?param=value). For example, use param=firstname to filter by the firstname metadata.

valuestringOptional

The value for the metadata filter specified in param. For example, value=john.

Responses

200

A paginated list of video objects.

application/json

get

GET /api/v1/videos HTTP/1.1
Host: app.birdie.so
Authorization: Bearer API-KEY
Accept: */*

200

A paginated list of video objects.

{
  "data": [
    {
      "id": 405258,
      "way": "received",
      "recorded_by": null,
      "requested_by": null,
      "bytes": 788903,
      "title": null,
      "console_logs": null,
      "created_at": "2025-03-18T22:42:34Z",
      "duration": 5866,
      "network_logs": null,
      "processing_status": "completed",
      "sharing_link": "https://share..birdie.so/jXuvxmQ",
      "thumbnail_file": "https://my-s3-bucket.s3.eu-west-3.amazonaws.com/videos/e4bf56a2/ZZxpyh7oqTFOBPf7OwGgP8QpX3VG6zO3.jpg?...",
      "transcription": null,
      "uuid": "17285378-e18a-4b5f-b47f-238f6d86dca4",
      "video_file": "https://my-s3-bucket.s3.eu-west-3.amazonaws.com/videos/e4bf56a2/lWMVumfEkrG6HkhpsULPWUGgq2O6K2ee.mp4?...",
      "origin": "sellsy",
      "ticket": "123ticketid",
      "params": {
        "ticket": "123ticketid",
        "pop": "corn",
        "new": "york"
      }
    },
    {
      "id": 405252,
      "way": "received",
      "recorded_by": null,
      "requested_by": "jb@birdie.so",
      "bytes": 779814,
      "title": null,
      "console_logs": null,
      "created_at": "2025-03-18T22:39:15Z",
      "duration": 5416,
      "network_logs": null,
      "processing_status": "completed",
      "sharing_link": "https://share.birdie.so/2Xuyr9v",
      "thumbnail_file": "https:/my-s3-bucket.s3.eu-west-3.amazonaws.com/videos/e4bf56a2/0Mpzm0YHzVIhZT76MW9mhP29TdfLNjXO.jpg?...",
      "transcription": null,
      "uuid": "4f791a8b-3e0d-4bb8-b158-bf490ab8c416",
      "video_file": "https://my-s3-bucket.s3.eu-west-3.amazonaws.com/videos/e4bf56a2/2MlTaOxp1ONHViNAI5k2q9TMzp7bsN8A.mp4?...",
      "origin": "inapp"
    }
  ],
  "links": {
    "first": "https://app.birdie.so/api/v1/videos?page=1",
    "last": null,
    "prev": null,
    "next": "https://app.birdie.so/api/v1/videos?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://app.birdie.so/api/v1/videos",
    "per_page": 50,
    "to": 50
  }
}