---
title: "Returns vehicles"
method: GET
path: "/vehicles"
tags: ["Vehicles"]
---

# Returns vehicles

`GET /vehicles`

## Query parameters

- `id` integer
- `per_page` integer
- `page` integer
- `order_by` string
- `order_direction` 'asc' | 'desc'
- `return` string
- `group_by` string
- `with` string
- `exclude` integer
- `q` string
- `manufacturer` string
- `picture_id` integer
- `model` string
- `registration_number` string
- `license_plate` string
- `condition` 'NEW' | 'USED' | 'LEASED' | 'DEFECT' | 'SORTED_OUT', nullable
- `date_of_purchase` string, date
- `next_maintenance` string, date
- `mot_expires` string, date
- `info` string
- `source` string
- `source_external_id` string

## Response `200`

Vehicles list

- union
  - object — Generic paginated response wrapper
    - `data` object[] — Vehicles list
      - `id` integer
      - `first_line` string — First line
      - `icon` string — Icon
      - `color` string — Color
      - `contrast_color` 'dark' | 'white' — Contrast color
      - `custom_number` string — Custom number
      - `picture_is_avatar` boolean — Picture is avatar
      - `picture_id` integer — Photo
      - `manufacturer` string — The manufacturer of the vehicle
      - `model` string — The model of the vehicle
      - `registration_number` string — The registration number of the vehicle
      - `license_plate` string — The license plate of the vehicle
      - `date_of_purchase` string, date — The date of purchase
      - `next_maintenance` string, date-time — The date of next maintenance
      - `mot_expires` string, date-time — The date when MOT expires
      - `condition` 'NEW' | 'USED' | 'LEASED' | 'DEFECT' | 'SORTED_OUT' — The condition of the vehicle
      - `info` string — Additional information about the vehicle
      - `reminded_mot_expires` boolean — Whether the user was reminded about MOT expiration
      - `source` string — The source of the vehicle data
      - `source_external_id` string, nullable — The external ID from the source
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `links` object
      - `first` string, nullable
      - `last` string, nullable
      - `prev` string, nullable
      - `next` string, nullable
    - `meta` object
      - `current_page` integer
      - `from` integer, nullable
      - `last_page` integer
      - `links` object[]
        - `url` string, nullable
        - `label` string
        - `active` boolean
      - `path` string
      - `per_page` integer
      - `to` integer, nullable
      - `total` integer
  - AggregateResponse — Returned instead of the paginated list when the "return=" parameter is used.
    - `data` object
      - `count` integer — Response envelope for the "return=" aggregate parameter (see general--return). Exactly one of the properties is present per response, depending on the requested aggregate.
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown
  - GroupedAggregateResponse — Returned instead of the paginated list when the "group_by=" parameter is used. One row per bucket.
    - `data` object[]
      - `count` integer — Response envelope for the "group_by=" parameter (see general--group_by). Each element is one bucket: the grouped column plus the requested aggregate (count by default, or one of sum/min/max/avg via "return=").
      - `sum` number, nullable
      - `avg` number, nullable
      - `min` unknown
      - `max` unknown

## Other responses

- `401` — The request lacks valid authentication credentials.
- `403` — The token is valid but lacks the permission for this action.
- `500` — An unexpected error occurred on the server (e.g. a requested relation does not exist).

---

[API](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation.md) · [All operations](https://skmtc.net/craftboxx/apis/craftboxx-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/craftboxx/craftboxx-api-documentation/revisions/c01f07a02f77/schema)