Channel List

POST/channel/list

See creation interface for filters description

Request

Header Params

Content-Type

string

optional

Example:

application/json

integer

Page number, starts from 1

optional

limit

integer

Items per page

optional

asc

boolean

Ascending order

optional

orderby

enum<string>

Sort by

optional

Allowed values:

created_atranking

query

string

Search keyword

optional

Search scope: channel name and description

team_id

integer

Team ID

optional

Filter channels managed by this team

is_my_managed

boolean

My managed

optional

Filter channels where I am the creator or a member of the management team

is_my_starred

boolean

My favorites

optional

Filter channels in my personal favorites

is_my_team

boolean

My team's channels

optional

Filter channels belonging to my teams

channel_ids

array[integer]

Channel ID list

optional

Search by specified IDs

is_brief

boolean

Only return name and ID information

required

When this parameter is specified, the system will ignore p and limit parameters and return information for all channels

{
  "p": 0,
  "limit": 0,
  "asc": true,
  "orderby": "created_at",
  "query": "string",
  "team_id": 0,
  "is_my_managed": true,
  "is_my_starred": true,
  "is_my_team": true,
  "channel_ids": [
    0
  ],
  "is_brief": true
}

Request samples

Responses

成功(200)

HTTP Code: 200

Content Type : JSONapplication/json

error

object

optional

code

string

required

message

string

required

data

object

optional

items

array[object (Channel) {13}]

Channel entry

required

has_next_page

boolean

Has next page

required

total

integer

Total entries

required

Not configured

Last modified: 2 个月前