List annotation groups

List annotation groups

In this article, you will learn how to list all annotation groups in a single file.

List annotation groups

Request Type: GET
Authorization Header: Authorization: ApiKey <my_api_token>
URL: https://app.banyanboard.com/api/assets/<my_file_uuid>/annotation_groups/

Results:
Info{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "total_comments": 1,
      "total_views": 8,
      "total_votes": 2,
      "annotations": [
        {
          "date_created": "2026-03-15T10:22:31.123456Z",
          "fill_color": "transparent",
          "height": "120.500",
          "path": "M 0 0 h 200 v 120 h -200 z",
          "stroke_color": "#ff5722",
          "stroke_width": 6,
          "top_left_x": "210.450",
          "top_left_y": "160.220",
          "text": "",
          "text_fontsize": 0,
          "type": "rectangle",
          "was_edited": true,
          "uuid": "a1f3c9d2-6b4a-4e2a-9f8c-3b7d9e4c1a55",
          "width": "200.000"
        }
      ],
      "asset": "c9d8f1a2-3b4c-4d5e-9f01-7a2b3c4d5e6f",
      "author": "user_47291",
      "author_nickname": "analytics_user_1",
      "media_type": "VI",
      "caption": "Highlight moment",
      "date_created": "2026-03-15T10:20:10.654321Z",
      "date_edited": null,
      "description": "",
      "end_time": "2.500",
      "start_time": "1.200",
      "was_edited": false,
      "uuid": "d4b7e2a9-8c3f-4a1b-b2c3-9d8e7f6a5b4c"
    },
    {
      "total_comments": 0,
      "total_views": 3,
      "total_votes": 0,
      "annotations": [
        {
          "date_created": "2026-03-16T08:11:05.987654Z",
          "fill_color": "transparent",
          "height": "140.750",
          "path": "M 70 70 m -70 0 a 70 70 0 1 0 140 0 a 70 70 0 1 0 -140 0",
          "stroke_color": "#03a9f4",
          "stroke_width": 5,
          "top_left_x": "360.100",
          "top_left_y": "140.900",
          "text": "",
          "text_fontsize": 0,
          "type": "circle",
          "was_edited": true,
          "uuid": "f2a9d3c4-7e6b-4c2a-8d1e-5f7a9b3c2d10",
          "width": "140.750"
        }
      ],
      "asset": "c9d8f1a2-3b4c-4d5e-9f01-7a2b3c4d5e6f",
      "author": "user_83920",
      "author_nickname": "video_tagging_user",
      "media_type": "VI",
      "caption": "Player focus",
      "date_created": "2026-03-16T08:10:00.123789Z",
      "date_edited": null,
      "description": "Tracking player movement",
      "end_time": "5.750",
      "start_time": "4.000",
      "was_edited": false,
      "uuid": "b8c2d1e4-5f6a-4b7c-9d0e-1a2b3c4d5e6f"
    }
  ]
}

    • Related Articles

    • List all annotations

      In this article, you will learn how to list all annotations in a single annotation group. List all annotations Request Type: GET Authorization Header: Authorization: ApiKey <my_api_token> URL: ...

    • Create annotation group

      In this article, you will learn how to create an annotation group. Create annotation group Request Type: POST Authorization Header: Authorization: ApiKey <my_api_token> URL: https://app.banyanboard.com/api/assets/<my_file_uuid>/annotation_groups/ ...

    • Create rectangle annotation

      In this article, you will learn how to create rectangle annotation. Create rectangle annotation Request Type: POST Authorization Header: Authorization: ApiKey <my_api_token> URL: ...

    • Create circle annotation

      In this article, you will learn how to create circle annotation. Create circle annotation Request Type: POST Authorization Header: Authorization: ApiKey <my_api_token> URL: ...

    • Create text annotation

      In this article, you will learn how to create text annotation. Create text annotation Request Type: POST Authorization Header: Authorization: ApiKey <my_api_token> URL: ...