> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Download vehicle event log

> Download vehicle event log

```http
POST https://api2.rhombussystems.com/api/export/vehicleEventsV2
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`.

## Request body

Content type: `application/json`. Request object for getting vehicle events with filters and additive queries.

- `deviceUuidFilter` (array<string<DeviceFacetUuid> | null> | null): Filter events by specific reporting device uuids
- `endTimeMs` (integer<int64> | null): Time window filter end (newest) time in Epoch milliseconds
- `licensePlateExactQuery` (array<string | null> | null): Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)
- `licensePlateFuzzyQuery` (string | null): Query events by partial or complete license plate with fuzzy character matching. Query fields are additive queries (returned events satisfy at least one of the query fields)
- `locationUuidFilter` (array<string<RUUID> | null> | null): Filter events by specific reporting location uuids
- `nameQuery` (array<string | null> | null): Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)
- `startTimeMs` (integer<int64> | null): Time window filter start (oldest) time in Epoch milliseconds
- `unnamedQuery` (boolean | null): Query events by name presence.  If false, returns events with a name.  If true, returns events without names.  Omit if not needed.  Query fields are additive queries (returned events satisfy at least one of the query fields)
- `vehicleLabelQuery` (array<string | null> | null): Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)

## Response 200

OK. Content type: `text/csv; charset=UTF-8`

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/export/vehicleEventsV2:
    post:
      description: Download vehicle event log
      operationId: exportVehicleEventsV2
      parameters:
        - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer <token>` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Vehicle_GetVehicleEventsWSRequest"
      responses:
        "200":
          content:
            text/csv; charset=UTF-8: {}
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Download vehicle event log
      tags:
        - Export Webservice
components:
  schemas:
    Vehicle_GetVehicleEventsWSRequest:
      description: Request object for getting vehicle events with filters and additive queries.
      properties:
        deviceUuidFilter:
          description: Filter events by specific reporting device uuids
          items:
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            format: DeviceFacetUuid
            nullable: true
            type: string
          nullable: true
          type: array
        endTimeMs:
          description: Time window filter end (newest) time in Epoch milliseconds
          format: int64
          nullable: true
          type: integer
        licensePlateExactQuery:
          description: Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)
          items:
            description: Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)
            nullable: true
            type: string
          nullable: true
          type: array
        licensePlateFuzzyQuery:
          description: Query events by partial or complete license plate with fuzzy character matching. Query fields are additive queries (returned events satisfy at least one of the query fields)
          nullable: true
          type: string
        locationUuidFilter:
          description: Filter events by specific reporting location uuids
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        nameQuery:
          description: Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)
          items:
            description: Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)
            nullable: true
            type: string
          nullable: true
          type: array
        startTimeMs:
          description: Time window filter start (oldest) time in Epoch milliseconds
          format: int64
          nullable: true
          type: integer
        unnamedQuery:
          description: Query events by name presence.  If false, returns events with a name.  If true, returns events without names.  Omit if not needed.  Query fields are additive queries (returned events satisfy at least one of the query fields)
          nullable: true
          type: boolean
        vehicleLabelQuery:
          description: Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)
          items:
            description: Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)
            nullable: true
            type: string
          nullable: true
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````
