List Channels

GET {{baseUrl}}/odaInstances/:odaInstanceId/channels?limit=100&sortOrder=DESC

Returns a page of Channels that belong to the specified Digital Assistant instance.

If the opc-next-page header appears in the response, then there are more items to retrieve. To get the next page in the subsequent GET request, include the header's value as the page query parameter.

Request Params

Example: MyChannel | | category | string | | List only Channels with this category. | | type | string | | List only Channels of this type. | | lifecycleState | string | | List only the resources that are in this lifecycle state. | | limit | number | | The maximum number of items to return per page. | | page | string | | The page at which to start retrieving results.

You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.

Example: MToxMA== | | sortOrder | string | | Sort the results in this order, use either ASC (ascending) or DESC (descending). | | sortBy | string | | Sort on this field. You can specify one sort order only. The default sort field is timeCreated.

The default sort order for timeCreated and timeUpdated is descending, and the default sort order for name is ascending. |

HEADERS

RESPONSES

status: OK

{"items":[{"id":"in amet aliquip in","name":"aliquip eu deserunt dolore","category":"BOT","type":"SLACK","lifecycleState":"UPDATING","timeCreated":"2011-04-09T11:33:37.626Z","timeUpdated":"2020-03-27T20:01:59.061Z","definedTags":{"elit1":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"eta":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"description":"esse mollit in incididunt","freeformTags":{"cupidatat__68":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"id":"adipisicing","name":"anim enim","category":"EVENT","type":"OSVC","lifecycleState":"DELETED","timeCreated":"1981-06-06T17:47:47.424Z","timeUpdated":"2016-08-25T09:35:11.088Z","definedTags":{"ea_08":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dolore2":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"minimf":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"description":"ex proident","freeformTags":{"aliquip6":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"culpa_c":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"minim_0_":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}]}