> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bevits.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List event types

> Every event name the store has sent, with its label, nature (utility or marketing), first and last occurrence, and the properties inferred from the events received (path, type, and example). The list comes whole, without pagination.



## OpenAPI

````yaml /openapi.en.json get /v1/event-types
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    Public API for querying CRM, purchase, and automation data from a Bevits
    organization, creating automations as drafts for review and activation,
    creating WhatsApp Official campaigns as drafts, and building customer
    segments and tags.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: System
    description: API availability.
  - name: Identity
    description: Organization and API key identity.
  - name: Customers
    description: Customers and their relationships.
  - name: Segments
    description: Customer segments.
  - name: Purchases
    description: Purchases imported from integrations.
  - name: CRM data
    description: Tags and attribute definitions.
  - name: Automations
    description: Automation flows.
  - name: Campaigns
    description: Email campaigns.
  - name: Account and brand
    description: Account context, brand identity, and images.
  - name: Recipes
    description: Ready-made automations created from recipes, with undo.
  - name: Email templates
    description: Creating and importing email templates.
  - name: Events
    description: Custom events sent by the store and their types.
paths:
  /v1/event-types:
    get:
      tags:
        - Events
      summary: List event types
      description: >-
        Every event name the store has sent, with its label, nature (utility or
        marketing), first and last occurrence, and the properties inferred from
        the events received (path, type, and example). The list comes whole,
        without pagination.
      operationId: listEventTypes
      parameters:
        - $ref: '#/components/parameters/IncludeArchived'
      responses:
        '200':
          $ref: '#/components/responses/EventTypeList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ReadScopeRequired'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    IncludeArchived:
      name: include_archived
      in: query
      description: Includes archived event types.
      schema:
        type: boolean
        default: false
  responses:
    EventTypeList:
      description: Event types.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EventTypeList'
          example:
            object: list
            data:
              - object: event_type
                name: order_shipped
                nature: utility
                archived: false
                first_seen_at: '2026-11-18T17:03:01.000Z'
                last_seen_at: '2026-11-18T19:40:12.000Z'
                properties:
                  - path: order_number
                    type: string
                    example: '10293'
                  - path: tracking
                    type: object
                  - path: tracking.code
                    type: string
                    example: BR123
                  - path: items
                    type: list
                  - path: items[]
                    type: object
                  - path: items[].quantity
                    type: number
                    example: 2
            has_more: false
    Unauthorized:
      description: Missing, invalid, expired, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    ReadScopeRequired:
      description: >-
        The API key does not have the read scope. This is the case of a
        send-only key, created with events:write alone.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: permission_denied
              code: missing_scope
              message: This API key does not have the required "read" scope.
              param: scope
              request_id: req_07f6cdc3c20249d6afcd90b4
    ValidationError:
      description: A parameter failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: validation_error
              message: Invalid query parameters.
              param: limit
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Request limit exceeded.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    EventTypeList:
      type: object
      required:
        - object
        - data
        - has_more
      properties:
        object:
          type: string
          const: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/EventType'
        has_more:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Seconds before retrying.
    EventType:
      type: object
      required:
        - object
        - name
        - archived
        - first_seen_at
        - last_seen_at
        - properties
      properties:
        object:
          type: string
          const: event_type
        name:
          type: string
        label:
          type: string
        nature:
          type: string
          enum:
            - utility
            - marketing
          description: >-
            utility: about something the customer did. marketing: requires
            consent. Absent when the name is outside the recommended events
            catalog.
        archived:
          type: boolean
        first_seen_at:
          type: string
          format: date-time
        last_seen_at:
          type: string
          format: date-time
        properties:
          type: array
          description: >-
            Properties inferred from the events received. path uses dots and []
            for list items.
          items:
            type: object
            required:
              - path
              - type
            properties:
              path:
                type: string
              type:
                type: string
                enum:
                  - string
                  - number
                  - boolean
                  - date
                  - list
                  - object
              example: {}
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        code:
          type: string
          description: >-
            Stable, machine-readable reason within type, such as
            invalid_event_name. Present when the error has a named reason.
        message:
          type: string
        param:
          type: string
          description: >-
            Full path of the offending field, such as customer.email or
            events[3].name.
        suggestion:
          type: string
          description: A value that would be accepted, when there is an obvious one.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Seconds before retrying.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Total limit for the current window.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: UTC instant when the current window ends.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key created in the organization settings.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.