Fetch all categories
This operation shows details for all categories available in Wowza Video.
Query parameters
Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.
For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.
Searches text fields case insensitive and partial. Full matches aren't required.
For categories, name and description are the only searchable fields.
Limit to a specific field with a colon (:).
If you have multiple search terms you can use pipe (|) to separate the search terms.
Examples:
| Query | Description |
|---|---|
| query=foo | Searches name & description field for foo. |
| query=foo:description | Searches description field for foo. |
| query=foo|bar | Searches name for foo and bar. A category must match both to be included. |
Only categories without parent categories will be returned if set to true.
Limit search to categories with a specific parent category. When specified, only child categories with the specified parent will be returned.
Response
Success
Example response
{
"categories": [
{
"category": {
"id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbbd",
"name": "My first category",
"description": "This is a category description.",
"parent_id": "cb65a918-ad7d-406a-80d8-09c9c8d0dbb"
}
}
],
"pagination": {
"total_records": 100,
"page": 1,
"per_page": 10,
"total_pages": 2,
"page_first_index": 10,
"page_last_index": 10
}
}