Skip to main content
GET
/
v3
/
vehicle-inspections
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/vehicle-inspections \
  --header 'X-Session-Token: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "inspected_at": "2023-11-07T05:31:56Z",
        "checks": {
          "visible_damage": true,
          "tyres": true,
          "washers_and_wipers": true,
          "windscreen": true,
          "number_plate": true,
          "security": true,
          "accessories": true,
          "spare_number_plate": true,
          "safe_access": true,
          "reversing_alarm": true,
          "beacons": true,
          "chemicals_and_fuel": true,
          "storage": true,
          "lights_and_indicators": true,
          "engine_warning_lights": true,
          "servicing": true,
          "levels": true,
          "cleanliness": true,
          "driver_checks": true
        },
        "comments": {
          "visible_damage": "<string>",
          "tyres": "<string>",
          "washers_and_wipers": "<string>",
          "windscreen": "<string>",
          "number_plate": "<string>",
          "security": "<string>",
          "accessories": "<string>",
          "spare_number_plate": "<string>",
          "safe_access": "<string>",
          "reversing_alarm": "<string>",
          "beacons": "<string>",
          "chemicals_and_fuel": "<string>",
          "storage": "<string>",
          "lights_and_indicators": "<string>",
          "engine_warning_lights": "<string>",
          "servicing": "<string>",
          "levels": "<string>",
          "cleanliness": "<string>",
          "driver_checks": "<string>"
        }
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "passed": 123,
        "failed": 123,
        "not_applicable": 123
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "vehicle": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "author": {
          "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": {
        "name": "<string>",
        "slug": "<string>",
        "sandbox": true,
        "description": "<string>",
        "settings": {}
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "features": [
          {
            "name": "<string>",
            "enabled": true,
            "limit": 123
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "groups": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "nomenclature": {
          "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 vehicle inspections by ID.
  • eq(organisation,xxx): Filter vehicle inspections by organisation ID.
  • eq(vehicle,xxx): Filter vehicle inspections by vehicle ID.
  • eq(author,xxx): Filter vehicle inspections by author user ID.
include
enum<string>[]

A comma separated list of related resources to include.

Available options:
author,
organisation,
vehicle
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 vehicle inspections.

JSON API response object

data
A list of vehicle inspections · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

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

An organisation