---
title: "List Vehicle Assignments"
method: GET
path: "/vehicle_assignments"
tags: ["Vehicle Assignments"]
---

# List Vehicle Assignments

`GET /vehicle_assignments`

## Request

- Base URL: `https://secure.fleetio.com/api`
- URL: `https://secure.fleetio.com/api/vehicle_assignments`
- Auth: API key in header `Authorization` and API key in header `Account-Token`
- TypeScript: <https://skmtc.dev/fleetio/apis/fleetio-developer-api/docs/vehicle_assignments/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of vehicle assignments.

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `contact_id` EqFilter
    - `eq` string, required
  - `vehicle_id` EqFilter
    - `eq` string, required
  - `ended_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `started_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `created_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `updated_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
- `sort` object
  - `started_at` 'asc' | 'desc'
  - `ended_at` 'asc' | 'desc'
  - `created_at` 'asc' | 'desc'
  - `updated_at` 'asc' | 'desc'
  - `id` 'asc' | 'desc'

## Response `200`

OK

- object
  - `start_cursor` string, nullable: The current start cursor of the records returned.
  - `next_cursor` string, nullable: The next cursor to retrieve the next page of records.
  - `per_page` integer: The maximum number of records returned.
  - `estimated_remaining_count` integer: The number of remaining records including the returned records, up to a maximum of 500.
  - `filtered_by` union[]: The filters applied to the returned record set.
    - union
      - object
        - `contact_id` EqFilter
          - `eq` string, required
      - object
        - `vehicle_id` EqFilter
          - `eq` string, required
      - object
        - `ended_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `started_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `created_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `updated_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
  - `sorted_by` union[]: The sorts applied to the returned record set.
    - union
      - object
        - `started_at` 'asc' | 'desc'
      - object
        - `ended_at` 'asc' | 'desc'
      - object
        - `created_at` 'asc' | 'desc'
      - object
        - `updated_at` 'asc' | 'desc'
      - object
        - `id` 'asc' | 'desc'
  - `records` VehicleAssignmentSummary[]
    - `custom_fields` CustomFields, nullable, required: *Full details on working with Custom Fields [here](/docs/overview/custom-fields).
    - `id` integer, required
    - `vehicle_id` integer, required: The id of the vehicle associated with this Vehicle Assignment.
    - `contact_id` integer, required: The id of the contact associated with this Vehicle Assignment.
    - `started_at` string, date-time, nullable, required: The date and time of this Vehicle Assignment. Dates in the future are accepted. We recommend using [ISO-8601](/docs/overview/date-formatting) formatted dates to avoid ambiguity.
    - `ended_at` string, date-time, nullable, required: The date and time of this Vehicle Assignment ending. We recommend using [ISO-8601](/docs/overview/date-formatting) formatted dates to avoid ambiguity.
    - `current` boolean, required: Whether this Vehicle Assignment is current/active.
    - `future` boolean, required: Whether this Vehicle Assignment is set to take place in the future.
    - `starting_meter_entry_value` number, nullable, required: The meter value at the start of this Vehicle Assignment.
    - `ending_meter_entry_value` number, nullable, required: The meter value at the end of this Vehicle Assignment.
    - `comments_count` integer, required: The number of comments on this Vehicle Assignment.
    - `attachment_permissions` AttachmentPermissions, nullable
      - `read_photos` boolean: Indicates whether the user has read permission for photos.
      - `manage_photos` boolean: Indicates whether the user has permission to manage (eg. upload, delete) photos.
      - `read_documents` boolean: Indicates whether the user has read permission for documents.
      - `manage_documents` boolean: Indicates whether the user has permission to manage (eg. upload, delete) documents.
    - `contact` ContactMini, nullable, required: A Contact
      - `id` integer
      - `email` string, nullable: The Contact's email address.
      - `name` string, nullable: The Contact's full name.
      - `group_id` integer, nullable: If this Contact belongs to a [Group](/docs/api/groups), this will be the Fleetio ID of that `Group`.
      - `employee` boolean, nullable: Whether or not the Contact is an employee.
      - `employee_number` string, nullable: The employee number of the Contact.
      - `default_image_url` string, nullable: The URL of the Contact's default image/profile photo, if any.
    - `vehicle` VehicleMini, required: A Vehicle
      - `id` integer, required
      - `name` string, required: This vehicle's name.
      - `color` string, nullable: The color of this Vehicle.
      - `license_plate` string, nullable: The license plate number of this Vehicle.
      - `vin` string, nullable: The Vehicle Identification Number of this Vehicle.
      - `year` string, nullable: This Vehicle's model year.
      - `make` string, nullable: The name of this Vehicle's manufacturer.
      - `model` string, nullable: The name of the model of this Vehicle.
      - `trim` string, nullable: The trim level of this Vehicle.
      - `registration_expiration_month` integer, nullable: The month in which this Vehicle's registration expires.
      - `registration_state` string, nullable: The state, province, or territory in which this Vehicle is registered.
      - `default_image_url_small` string, nullable: The URL of a small-sized version of the default image for this Vehicle.

## Other responses

- `400`: The format or parameters of the request was invalid
- `401`: Request could not be authenticated
- `500`: Something unexpected happened

## Changes

- **2026-11-06** `49558d744bd7`: 2 info
  - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00`
  - added the required property `records/items/custom_fields` to the response with the `200` status
- **2026-02-13** `1172c0b6ab85`: 1 info
  - added `subschema #4` to the `filtered_by/items/` response property `anyOf` list for the response status `200`
- **2025-09-06** `6daa53a03224`: 3 breaking, 2 info
  - the response property `records/items/contact/default_image_url` became optional for the status `200`
  - the response property `records/items/contact/id` became optional for the status `200`
  - the response property `records/items/contact/name` became optional for the status `200`
  - added the optional property `records/items/contact/employee` to the response with the `200` status
  - …1 more

[Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/vehicle_assignments/get.md)

---

[API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)