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

Obtaining the Event Schema List

Function

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

URI

GET /v1/{project_id}/schemas

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 schema. It is used for exact match.

fuzzy_name

No

String

Name of the event schema. It is used for fuzzy 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 CustomizeSchemaItemInfo objects

Object list.
Table 5 CustomizeSchemaItemInfo

Parameter

Type

Description

id

String

ID of the event schema.

name

String

Name of the event schema. The value must be unique under a tenant.

description

String

Description of the event schema.

compatibility

String

Compatibility of the event schema.

provider_type

String

Type of the event source provider, which can be OFFICIAL (official event source) or CUSTOM (custom event source).

format

String

Format of the event schema.

number_of_versions

Integer

Number of event schema versions.

event_type_id

String

Event type ID.

event_type_name

String

Name of the event type.

event_source_id

String

ID of the event source.

event_source_name

String

Event source name.

event_source_label

String

Event source label.

created_time

String

Time when the event schema is created.

updated_time

String

Time when the event schema is updated.

Example Requests

Obtain the event schema list.

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

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 Schema Management