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

# List all events

> Returns all events, most recent first.



## OpenAPI

````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /events
openapi: 3.0.3
info:
  description: >-
    The Flatpeak Fleet API. VPP operators use it to enroll, dispatch and settle
    OEM device fleets.


    ## Authentication

    Exchange your `account_id` and `secret_key` for a bearer token at `POST
    /auth/tokens` with basic auth. Send it as `Authorization: Bearer <token>` on
    every request.


    ## Base URL

    `https://fleet-api.flatpeak.com`


    ## Pagination

    Lists return `data`, `next_cursor` and `url`. Pass `next_cursor` as `cursor`
    until it is `null`. A cursor is opaque and bound to the endpoint and query
    parameters that issued it.


    ## Errors

    Every non-2xx response carries `object`, `type`, `code` and `message`.
    Branch on `code`.


    ## Money and energy

    Money is a decimal number paired with a `currency_code` (ISO 4217). Power is
    in kW and energy in kWh. Positive is import, negative is export.


    ## Live and test

    `live_mode` marks live or test data.
  version: 2027-01-01.busbar
  title: Flatpeak Fleet API
  termsOfService: https://flatpeak.com/legal
  contact:
    name: Technical Support
    email: support@flatpeak.com
    url: https://flatpeak.com/contact
  license:
    name: Apache 2.0
    url: https://flatpeak.com/legal
servers:
  - url: https://fleet-api.flatpeak.com
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: >-
      Exchange your account credentials for a bearer token to authenticate API
      requests.
  - name: Connect
    description: >-
      Create and retrieve Connect sessions for onboarding customers through your
      own app.
  - name: OEMs
    description: List and retrieve the OEMs whose devices your fleet can reach.
  - name: Devices
    description: >-
      Retrieve, list and update the devices connected to your account, and read
      their consent history and shared settings.
  - name: Locations
    description: >-
      Read the location a device sits behind: its timezone, currency, metering
      and your devices there.
  - name: Dispatch
    description: Submit plans to devices on managed tariffs and read the dispatch timeline.
  - name: Telemetry
    description: Read device state, device meter records and location meter records.
  - name: Tariffs
    description: Create, retrieve, delete, and list tariffs.
  - name: Events
    description: Retrieve and list account events.
  - name: VPP Programs
    description: >-
      Define and manage VPP programs: the commercial terms devices enroll under,
      and their live state.
  - name: Groups
    description: >-
      Named collections of devices for bulk dispatch and aggregated reads. OEMs
      see them read-only as [groups](/energy-api/reference/groups/list) on the
      Energy API.
  - name: Zones
    description: >-
      Network areas resolved to devices by Flatpeak, for locational eligibility
      and grouping without handling addresses.
  - name: Exports
    description: >-
      Package settlement evidence, consent records and enrollment registers as
      downloadable files.
  - name: Rewards
    description: >-
      The reward ledger: entries accrue from delivery, you approve them, pay the
      customers and mark them paid.
  - name: VPP Enrollments
    description: Track and act on device enrollments across your programs.
  - name: VPP Events
    description: >-
      Commit market activations: create an event for a group, then read its
      state and its devices' results.
externalDocs:
  description: Documentation
  url: https://docs.flatpeak.com
paths:
  /events:
    parameters: []
    get:
      tags:
        - Events
      summary: List all events
      description: Returns all events, most recent first.
      operationId: get-events
      parameters:
        - $ref: '#/components/parameters/event_type'
        - $ref: '#/components/parameters/cursor'
        - $ref: '#/components/parameters/limit'
        - schema:
            type: string
            example: dev_63a6087272941ef077a8fd3e
          in: query
          name: object_id
          description: >-
            Only events about this object, for example a device or enrollment
            ID.
      responses:
        '200':
          $ref: '#/components/responses/EventList'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        '503':
          $ref: '#/components/responses/503'
components:
  parameters:
    event_type:
      name: type
      in: query
      required: false
      schema:
        type: string
      description: >-
        Event type to filter by. See
        [Events](/fleet-api/guides/platform/events).
    cursor:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: >-
        Pagination cursor. Pass `next_cursor` from the previous response
        unchanged; omit for the first page. A cursor used with different
        parameters returns `400 cursor_invalid`.
    limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 30
      description: >-
        Maximum number of objects to return per page. Between 1 and 100, default
        30. Values above 100 are clamped to 100.
  responses:
    '401':
      description: '401 Unauthorized: authentication credentials are missing or invalid.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '403':
      description: '403 Forbidden: you do not have permission to access this resource.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '404':
      description: '404 Not Found: the requested resource does not exist.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '429':
      description: '429 Too Many Requests: the rate limit has been exceeded.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '500':
      description: >-
        500 Internal Server Error: an unexpected error occurred. Safe to retry
        with backoff.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    '503':
      description: >-
        503 Service Unavailable: the service is temporarily down for
        maintenance. Retry after the indicated delay.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    EventList:
      description: Event list response.
      content:
        application/json:
          schema:
            type: object
            properties:
              object:
                type: string
                description: Object type, `list`.
                example: list
                enum:
                  - list
              url:
                type: string
                description: URL slug for the object.
                example: /events
              next_cursor:
                type: string
                nullable: true
                description: >-
                  Cursor for the next page. Pass it as `cursor`. `null` on the
                  last page. Page until it is `null`, even if `data` is short or
                  empty.
                example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Event'
            required:
              - object
              - url
              - next_cursor
              - data
          example:
            object: list
            url: /events
            next_cursor: null
            data:
              - id: evt_66cd1a83f0b25d4e7a3c6e15
                object: event
                live_mode: true
                type: vpp_enrollment.update
                data:
                  device_id: dev_63a6087272941ef077a8fd3e
                  enrollment_id: enr_7c2f1a9e4b0d8f3a6e2c5d10
                time_created: '2026-07-08T11:25:39Z'
  schemas:
    Event:
      type: object
      properties:
        id:
          type: string
          example: evt_65e42b7827c0526548432b9f
          description: Flatpeak Event ID.
          pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
        object:
          type: string
          example: event
          description: Object type, `event`.
          enum:
            - event
          default: event
        live_mode:
          type: boolean
          description: '`true` for live data, `false` for test data.'
          example: true
        type:
          type: string
          example: device.connect
          description: >-
            Event type, for example `device.settings.update`. The full list is
            in the [events guide](/fleet-api/guides/platform/events).
        data:
          type: object
          description: >-
            Identifiers of the affected object, for example `device_id`. The
            [events guide](/fleet-api/guides/platform/events#event-data) lists
            the keys for each type. Retrieve the object for its current state.
        time_created:
          type: string
          example: '2026-01-24T14:15:22Z'
          description: Time when the event occurred, in UTC.
          format: date-time
      required:
        - id
        - object
        - live_mode
        - type
        - data
        - time_created
    Error:
      type: object
      description: Standard error envelope returned by every non-2xx response.
      required:
        - object
        - type
        - code
        - message
      properties:
        object:
          type: string
          enum:
            - error
          default: error
          description: Object type.
        type:
          type: string
          description: High-level error category.
          example: invalid_request
        code:
          type: string
          description: Machine-readable error code, safe to branch on.
          example: access_denied
        message:
          type: string
          description: Human-readable description of the error.
          example: The requested resource could not be found.
        context:
          type: string
          description: Optional originating context, for example `api.price_get`.
          example: api.price_get
        live_mode:
          type: boolean
          description: Whether the error occurred against live or test data.
        time_created:
          type: string
          format: date-time
          description: Time the error was generated (RFC 3339).
          example: '2026-01-01T00:00:00Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate with the `bearer_token` obtained from the
        [authentication](/fleet-api/reference/authentication) endpoint.

````

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