View hub categories.

Supported Formats

json

GET https://api.vidyard.com/dashboard/v1/hubs/:id/categories
List all categories for a hub

List all categories for a hub

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "categories": [
      {
        "name": "Test Category 1",
        "categorizable_type": "Hub",
        "categorizable_id": 996,
        "category_type": "selection",
        "tags": [],
        "id": 1242,
        "created_at": 1411501896,
        "updated_at": 1430165964
      },
      {
        "name": "Test Category 2",
        "categorizable_type": "Hub",
        "categorizable_id": 996,
        "category_type": "tags",
        "tags": [
          {
            "name": "test",
            "taggable_type": "Video",
            "id": 56227,
            "created_at": 1419020182
          }
        ],
        "id": 1522,
        "created_at": 1425351663,
        "updated_at": 1425351663
      }
  ],
  "summary":{
    "page": 1,
    "per_page": 2,
    "count": 5
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Validations:

  • Parameter has to be Integer.

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.