---
title: "Get Event Types"
url: "https://api-docs.centraldispatch.com/apis/event-api-1-0-0/versions/21e75d36-6f5f-432d-aa52-513be4b55173/operations/getEventTypes"
---

> Full API specification: https://api-docs.centraldispatch.com/apis/event-api-1-0-0/versions/21e75d36-6f5f-432d-aa52-513be4b55173.md

# Get Event Types

`GET` `/event-types`

Operation ID: `getEventTypes`

Get a collection of all events currently offered. Returns a list of event types and descriptions, enabling users to create subscriptions for events of interest.

## Header parameters

- `Accept` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v1+json`.

## Responses

- `200` - OK. Successful request.
- `401` - Unauthorized. Authentication failed or missing.
- `403` - Forbidden. The attempted action is not permitted.
- `429` - Too Many Requests. Rate limit exceeded.
- `500` - Error.
- `503` - Service Unavailable. Temporary service interruption.

## OpenAPI definition

```yaml
openapi: 3.0.1
info:
  title: Event API
  version: 1.0.0
servers:
  - url: https://event-api.centraldispatch.com
    description: Production server
paths:
  /event-types:
    get:
      tags:
        - Event
      summary: Get Event Types
      description: >-
        
        Get a collection of all events currently offered.

        Returns a list of event types and descriptions, enabling users to create
        subscriptions for events of interest.
      operationId: getEventTypes
      parameters:
        - name: Accept
          in: header
          description: The major version of the API to make a request against. This is a
            custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to
            request a resource from version 1.x.x of an API, the Accept header
            should be set to `application/vnd.coxauto.v1+json`.
          required: true
          schema:
            type: string
          example: application/vnd.coxauto.v1+json
      responses:
        "200":
          description: OK. Successful request.
          headers:
            X-CoxAuto-Media-Type:
              description: Contains the major version and format information.
              schema:
                type: string
              example: coxauto.v1; format=json
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventTypeCollection"
        "401":
          description: Unauthorized. Authentication failed or missing.
        "403":
          description: Forbidden. The attempted action is not permitted.
        "429":
          description: Too Many Requests. Rate limit exceeded.
        "500":
          description: Error.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Errors"
        "503":
          description: Service Unavailable. Temporary service interruption.
      security:
        - Bearer: []
security:
  - Bearer: []
components:
  schemas:
    EventTypeCollection:
      required:
        - href
        - count
        - items
      type: object
      properties:
        href:
          type: string
          description: The URL used to query the current collection of the resource.
          example: https://event-api.centraldispatch.com/event-types
        count:
          type: integer
          description: The total count of resources in the collection.
          format: int32
          example: 1
        items:
          type: array
          items:
            $ref: "#/components/schemas/EventTypeResponse"
          description: A collection of records.
      description: Details of the event types.
    Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: "#/components/schemas/Error"
          description: A collection of errors.
          nullable: true
      description: An error occurred, and the request could not be completed.
    EventTypeResponse:
      type: object
      properties:
        eventType:
          type: string
          description: The type of the event.
          nullable: true
          example: DispatchCreated
        description:
          type: string
          description: The description of the event type.
          nullable: true
          example: A dispatch has been created
      description: Details of an event type.
    Error:
      type: object
      properties:
        code:
          type: string
          description: The code used for the issue.
          nullable: true
          example: resource.issue_type
        message:
          type: string
          description: A detailed message.
          nullable: true
          example: The issue happened because something is wrong.
        property:
          type: string
          description: The property to which the issue is associated.
          nullable: true
          example: person
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties related to the issue.
          nullable: true
          example:
            firstName: D0nn@
            lastName: Sm!th
      description: Details of an error or issue.
  securitySchemes:
    Bearer:
      type: http
      scheme: Bearer
```