Help Center/ EventGrid/ API Reference/ APIs/ Event Channel Management/ Obtaining the Event Channel List
Updated on 2025-05-06 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Event Channel List

Function

This API is used to obtain the list of event channels, including system and custom channels.

URI

GET /v1/{project_id}/channels

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant resource space ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The value must be within the range [1, 1000].

sort

No

String

Sorting mode of the query results.

provider_type

No

String

Type of the provider.

name

No

String

Name of the event channel. It is used for exact match.

fuzzy_name

No

String

Name of the event channel. It is used for fuzzy match.

enterprise_project_id

No

String

Enterprise project ID for exact match.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total number of records.

size

Integer

Number of records displayed on the current page.

items

Array of ChannelInfo objects

Object list.
Table 5 ChannelInfo

Parameter

Type

Description

id

String

ID of the event channel.

name

String

Name of the event channel.

description

String

Description of the event channel.

provider_type

String

Event channel provider type, which can be OFFICIAL (official event channel), CUSTOM (custom event channel), or PARTNER (partner event channel).

created_time

String

UTC time when the event channel is created.

updated_time

String

UTC time when the event channel is updated.

enterprise_project_id

String

Enterprise project ID.

Example Requests

Obtain the event channel list.

GET https://{endpoint}/v1/{project_id}/channels

Example Responses

Status code: 200

Operation successful.

{
  "total" : 1,
  "size" : 1,
  "items" : [ { } ]
}

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: Event Channel Management