> ## Documentation Index > Fetch the complete documentation index at: https://togai.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List event schemas > Returns a list of event schema with pagination. ## OpenAPI ````yaml get /event_schema openapi: 3.0.3 info: version: '1.0' title: Togai Apis contact: email: engg@togai.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html description: APIs for Togai App servers: - description: Api endpoint url: https://api.togai.com/ - description: Sandbox api endpoint url: https://sandbox-api.togai.com/ security: - bearerAuth: [] tags: - name: Customers description: Customer level calls - name: Accounts description: Account level calls - name: Event Schemas description: Event Schema level calls - name: Usage Meters description: Usage Meter level calls - name: Price Plans description: Price Plan level calls - name: Settings description: Settings - name: Price Experimentation description: Price Experimentation apis - name: InvoiceGroups description: Invoice Group level calls - name: Organization description: Organization level calls - name: FileStorage description: File Storage level calls - name: Aliases description: Alias level calls - name: Event Management description: APIs for getting events ingested in Togai externalDocs: description: docs url: https://togai.com/docs/billing/events - name: Metrics description: APIs for getting Togai metrics externalDocs: description: docs url: https://togai.com/docs/metrics - name: Licenses description: APIs for getting or updating license records in Togai - name: Entitlements description: APIs related to entitlements - name: Invoices description: Invoices API - name: Credits description: Credits API - name: Wallet description: Wallet API - name: InvoiceTemplates description: InvoiceTemplates API - name: Payments description: Payments API - name: Authentication description: Authentication API externalDocs: description: Find out more about Togai url: https://docs.togai.com/docs paths: /event_schema: get: tags: - Event Schemas summary: List event schemas description: Returns a list of event schema with pagination. operationId: listEventSchemas parameters: - name: status description: Filter by provided status in: query required: false schema: type: string enum: - ACTIVE - INACTIVE - $ref: '#/components/parameters/next_token' - $ref: '#/components/parameters/page_size' responses: '200': $ref: '#/components/responses/EventSchemaListPaginatedResponse' '400': $ref: '#/components/responses/ErrorResponse' '401': $ref: '#/components/responses/ErrorResponse' '403': $ref: '#/components/responses/ErrorResponse' '404': $ref: '#/components/responses/ErrorResponse' '429': $ref: '#/components/responses/ErrorResponse' default: $ref: '#/components/responses/ErrorResponse' components: parameters: next_token: in: query name: nextToken required: false schema: type: string example: >- eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ== page_size: in: query name: pageSize required: false schema: type: number example: 10 responses: EventSchemaListPaginatedResponse: description: Response for list events request content: application/json: schema: $ref: '#/components/schemas/EventSchemaListPaginatedResponse' examples: EventSchemaPaginatedResponse: $ref: '#/components/examples/EventSchemaListPaginatedResponse' ErrorResponse: description: Error response content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: ErrorResponse: summary: Error message value: message: schemas: EventSchemaListPaginatedResponse: type: object additionalProperties: false properties: data: type: array items: $ref: '#/components/schemas/EventSchemaListData' nextToken: type: string context: $ref: '#/components/schemas/PaginationOptions' ErrorResponse: type: object additionalProperties: false required: - message properties: message: type: string description: error description maxLength: 500 EventSchemaListData: allOf: - $ref: '#/components/schemas/EventSchema' - type: object properties: usageMetersCount: type: integer PaginationOptions: type: object additionalProperties: false properties: pageSize: type: integer sortOrder: type: string enum: - ASC - DESC EventSchema: description: Structure of an event schema type: object additionalProperties: false required: - name - version properties: name: description: Name of the event. Must be unique for an organization. type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ description: description: Description of the event type: string maxLength: 255 version: description: Version of event schema type: integer format: int32 minimum: 1 example: 1 status: description: | Status of event schema * DRAFT - Schema is in draft state * ACTIVE - Schema is currently active * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema type: string enum: - DRAFT - ACTIVE - INACTIVE - ARCHIVED example: DRAFT attributes: type: array maxItems: 50 items: $ref: '#/components/schemas/EventAttributeSchema' uniqueItems: true dimensions: type: array maxItems: 50 items: $ref: '#/components/schemas/DimensionsSchema' uniqueItems: true featureDetails: $ref: '#/components/schemas/FeatureDetails' enrichments: $ref: '#/components/schemas/Enrichments' eventLevelRevenue: type: boolean createdAt: type: string format: date-time updatedAt: type: string format: date-time EventAttributeSchema: description: Structure of an event attribute type: object additionalProperties: false required: - name properties: name: description: Name of the event attribute. type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ example: distance defaultUnit: description: Unit for the attribute type: string maxLength: 10 example: kms DimensionsSchema: description: Structure of dimensions type: object additionalProperties: false required: - name properties: name: description: Name of the event dimension type: string maxLength: 50 pattern: ^[\sa-zA-Z0-9_-]*$ example: city FeatureDetails: description: details of feature associated with event schema with attribute name type: object additionalProperties: false required: - featureId - attributeName properties: featureId: type: string attributeName: type: string Enrichments: type: object additionalProperties: false required: - fields properties: dependencies: type: array items: $ref: '#/components/schemas/Dependency' fields: type: array items: $ref: '#/components/schemas/Field' Dependency: type: object additionalProperties: false required: - type - key - name properties: type: type: string enum: - SETTING key: type: string name: type: string Field: type: object additionalProperties: false required: - name - type - enrichmentType - value - order properties: name: type: string type: type: string enum: - ATTRIBUTE - DIMENSION enrichmentType: type: string enum: - VALUE - JSON_LOGIC - JSON_LOGIC_FROM_DEPENDENCY value: type: string order: type: integer format: int32 examples: EventSchemaListPaginatedResponse: value: data: - name: ride_completed description: Cab ride completed version: 1 status: DRAFT attributes: - name: distance - name: time dimensions: - name: city - name: ride_type usageMetersCount: 10 nextToken: >- eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ== context: pageSize: 10 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.