Skip to main content

List channels

GET 
/channels

Retrieves a list of all Channels within the current authorization scope.

Filtering by featured state:

  • filter=featuredAtUtc!=null: Lists only featured Channel objects.
  • filter=featuredAtUtc=null: Lists only Channel objects that are not featured.

The X-*-Count response headers reflect the active filters, except type and visibility filters, which they ignore.

Request​

Responses​

Successful response.

Response Headers
    X-Total-Count

    Total count of items

    X-Group-Count

    Total count of Channels of type Group

    X-User-Count

    Total count of Channels of type User

    X-Interactive-Count

    Total count of Channels of type Interactive

    X-Public-Count

    Total count of Channels of visibility Public

    X-Private-Count

    Total number of private group Channels

    X-Shared-Count

    Total number of shared group Channels

    X-Featured-Count

    Total number of featured group Channels