v1
latestOpenAPI 3.0.02026-07-24212113249.1 KBChannels
List channels
get/channels
Query parameters
pageSizenumber
Number of documents that will be returned
pagenumber
Page to search. Page numbering starts with 0.
sortBystring
Controls the sorting. Format: <field_name>.<asc|desc> (asc for ascending order, desc for descending order). If no order specified it will be in descending order.
name__exactstring
Channel name
status__exactstring
Channel status
Headers
organizationstring required
The URL of the end-user web application
Response
Successful response
Example response
{
"page": 1,
"pageSize": 20,
"total": 1,
"pageCount": 1,
"pageNumberIsGood": true,
"isFirstPage": true,
"isLastPage": true,
"rows": [
{
"id": "3649593763a63ab59e096487",
"name": "Your Channel",
"slug": "your-channel",
"organization": "639cfa9a3efc39a89a96d6dw",
"description": "Channel description",
"status": "PUBLISHED",
"customization": {
"logo": {
"light": {
"imgPath": "image/path",
"baseUrl": "server.com"
},
"dark": {
"imgPath": "image/path",
"baseUrl": "server.com"
}
},
"icon": {
"light": {
"imgPath": "image/path",
"baseUrl": "server.com"
},
"dark": {
"imgPath": "image/path",
"baseUrl": "server.com"
}
},
"thumbnail": {
"imgPath": "image/path",
"baseUrl": "server.com"
}
},
"kind": "PRIVATE",
"access": "AVAILABLE"
}
]
}