> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.track.graviton.ma/llms.txt
> Use this file to discover all available pages before exploring further.

# List events

> Works with resources accessible to your account. Subaccounts need the `event_notifications` permission.



## OpenAPI

````yaml /openapi.json get /events
openapi: 3.0.3
info:
  title: Graviton Geo V1 Client API
  version: 2.0.0
  description: >-
    Client API for Graviton Geo V1. Use an API token to access your fleet,
    tracking, resources, commands, and reports. The REST API base path is
    /api/v2.
servers:
  - url: https://fleet.graviton.ma/api/v2
    description: Production
security:
  - ApiKey: []
tags:
  - name: System
  - name: Account
  - name: Fleet
  - name: Tracking
  - name: Commands
  - name: Places
  - name: People and groups
  - name: Events
  - name: Maintenance
  - name: Sensors
  - name: Reports
  - name: Templates
paths:
  /events:
    get:
      tags:
        - Events
      summary: List events
      description: >-
        Works with resources accessible to your account. Subaccounts need the
        `event_notifications` permission.
      operationId: get_events
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
        - $ref: '#/components/parameters/Search'
        - $ref: '#/components/parameters/Order'
        - name: sort
          in: query
          description: Registered field used for sorting.
          schema:
            type: string
            enum:
              - event_id
              - type
              - name
              - active
              - week_days
              - day_time
              - imei
              - checked_value
              - route_trigger
              - zone_trigger
              - routes
              - zones
              - notify_system
              - notify_email
              - notify_email_address
              - notify_sms
              - notify_sms_number
              - notify_telegram
              - email_template_id
              - sms_template_id
              - cmd_send
              - cmd_gateway
              - cmd_type
              - cmd_string
            default: event_id
        - name: type
          in: query
          description: Exact-match filter for type.
          schema:
            type: string
        - name: name
          in: query
          description: Exact-match filter for name.
          schema:
            type: string
        - name: active
          in: query
          description: Exact-match filter for active.
          schema:
            type: string
        - name: week_days
          in: query
          description: Exact-match filter for week_days.
          schema:
            type: string
        - name: day_time
          in: query
          description: Exact-match filter for day_time.
          schema:
            type: string
        - name: imei
          in: query
          description: Exact-match filter for imei.
          schema:
            type: string
        - name: checked_value
          in: query
          description: Exact-match filter for checked_value.
          schema:
            type: string
        - name: route_trigger
          in: query
          description: Exact-match filter for route_trigger.
          schema:
            type: string
        - name: zone_trigger
          in: query
          description: Exact-match filter for zone_trigger.
          schema:
            type: string
        - name: routes
          in: query
          description: Exact-match filter for routes.
          schema:
            type: string
        - name: zones
          in: query
          description: Exact-match filter for zones.
          schema:
            type: string
        - name: notify_system
          in: query
          description: Exact-match filter for notify_system.
          schema:
            type: string
        - name: notify_email
          in: query
          description: Exact-match filter for notify_email.
          schema:
            type: string
        - name: notify_email_address
          in: query
          description: Exact-match filter for notify_email_address.
          schema:
            type: string
        - name: notify_sms
          in: query
          description: Exact-match filter for notify_sms.
          schema:
            type: string
        - name: notify_sms_number
          in: query
          description: Exact-match filter for notify_sms_number.
          schema:
            type: string
        - name: notify_telegram
          in: query
          description: Exact-match filter for notify_telegram.
          schema:
            type: string
        - name: email_template_id
          in: query
          description: Exact-match filter for email_template_id.
          schema:
            type: string
        - name: sms_template_id
          in: query
          description: Exact-match filter for sms_template_id.
          schema:
            type: string
        - name: cmd_send
          in: query
          description: Exact-match filter for cmd_send.
          schema:
            type: string
        - name: cmd_gateway
          in: query
          description: Exact-match filter for cmd_gateway.
          schema:
            type: string
        - name: cmd_type
          in: query
          description: Exact-match filter for cmd_type.
          schema:
            type: string
        - name: cmd_string
          in: query
          description: Exact-match filter for cmd_string.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        event_id:
                          oneOf:
                            - type: number
                            - type: string
                          description: >-
                            Numeric value; legacy values may be serialized as
                            strings.
                        type:
                          description: Type.
                        name:
                          description: Name.
                        active:
                          description: Active.
                        week_days:
                          description: Week days.
                        day_time:
                          description: Day time.
                        imei:
                          description: Imei.
                        checked_value:
                          description: Checked value.
                        route_trigger:
                          description: Route trigger.
                        zone_trigger:
                          description: Zone trigger.
                        routes:
                          description: Routes.
                        zones:
                          description: Zones.
                        notify_system:
                          description: Notify system.
                        notify_email:
                          description: Notify email.
                        notify_email_address:
                          description: Notify email address.
                        notify_sms:
                          description: Notify sms.
                        notify_sms_number:
                          description: Notify sms number.
                        notify_telegram:
                          description: Notify telegram.
                        email_template_id:
                          description: Email template id.
                        sms_template_id:
                          description: Sms template id.
                        cmd_send:
                          description: Cmd send.
                        cmd_gateway:
                          description: Cmd gateway.
                        cmd_type:
                          description: Cmd type.
                        cmd_string:
                          description: Cmd string.
                      additionalProperties: true
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
components:
  parameters:
    Page:
      name: page
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
    PerPage:
      name: per_page
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 50
    Search:
      name: search
      in: query
      description: >-
        Partial text search across the resource's registered safe search fields.
        Whitespace is trimmed; literal percent and underscore characters are
        escaped. Search is applied after account, ownership, privilege, and
        object scope.
      schema:
        type: string
        minLength: 2
        maxLength: 100
    Order:
      name: order
      in: query
      schema:
        type: string
        enum:
          - asc
          - desc
        default: asc
  schemas:
    Meta:
      type: object
      properties:
        request_id:
          type: string
        page:
          type: integer
        per_page:
          type: integer
        total:
          type: integer
        pages:
          type: integer
    ErrorEnvelope:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/Meta'
  responses:
    Error:
      description: API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Your Graviton API token. Send Authorization: Bearer YOUR_API_TOKEN or
        Authorization: YOUR_API_TOKEN. Each token has individual permissions; a
        valid token without the permission required by the method and route
        returns 403 TOKEN_PERMISSION_DENIED.

````

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