Skip to main content
GET
/
v3
/
vehicles
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/vehicles \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "registration": "<string>",
        "vin": "<string>",
        "description": "<string>",
        "colour": "<string>",
        "status": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "sorn": true,
        "has_recall": true,
        "last_odometer_reading": 123,
        "counts": {
          "equipment": 123
        },
        "mot": {
          "is_valid": true,
          "records": 123,
          "last": {
            "at": "2023-11-07T05:31:56Z",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "tax": {
          "is_valid": true,
          "due": "<string>"
        },
        "checks": {
          "inventory": {
            "count": 123,
            "last": {
              "at": "2023-11-07T05:31:56Z",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          },
          "inspection": {
            "count": 123,
            "last": {
              "at": "2023-11-07T05:31:56Z",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          }
        },
        "dvla": {
          "mot": {
            "exists": true,
            "last_sync": "2023-11-07T05:31:56Z",
            "data": {}
          },
          "ves": {
            "exists": true,
            "last_sync": "2023-11-07T05:31:56Z",
            "data": {}
          }
        }
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "specification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "equipment": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "team": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "assignee": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "serial": "<string>",
        "status": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "model": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "vehicle": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

​
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter vehicles by ID.
  • eq(organisation,xxx): Filter vehicles by organisation ID.
  • eq(registration,xxx): Filter vehicles by registration number.
  • contains(registration,xxx): Filter vehicles where registration contains value.
  • eq(specification,xxx): Filter vehicles by specification ID.
  • eq(team,xxx): Filter vehicles by team ID.
  • eq(assignee,xxx): Filter vehicles by assignee user ID.
  • eq(status,xxx): Filter vehicles by status.

For more information on using named filters, see the docs

​
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
assignee,
equipment,
organisation,
specification,
team
​
limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
​
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0

Response

Get a list of vehicles.

JSON API response object

​
data
A list of vehicles · object[]
required
​
meta
object
required
​
jsonapi
object
required
​
included
object[]

Related resources that can be included when a vehicle is returned.

An equipment item