Cars API — vehicle catalog and classes

The Cars API lets you query and manage the vehicle catalog used across PitPath Chrono events. Each car belongs to a car brand (the manufacturer) and a car class (the performance category). You must create a brand and a class before creating a car that references them. GET endpoints are public. Creating or updating records requires a CRUD+ role.

Car object

string (UUID)

required

Unique identifier for the car.

string (UUID)

required

UUID of the car brand (manufacturer).

string

required

Display name of the manufacturer.

string

required

Model name of the car (1–120 characters).

string (UUID)

required

UUID of the car class.

string

required

Display name of the car class.

boolean

Whether the car appears in public listings.

string (ISO 8601)

Timestamp when the car was created.

string (ISO 8601)

Timestamp of the most recent update.

List cars

Public endpoint — no authentication required.

Returns all enabled cars as an unordered list.

GET /api/v1/cars

Example request

cURL

curl https://chrono.pitpath.de/api/v1/cars \
  -H "X-API-Key: YOUR_API_KEY"

Example response

200

[
  {
    "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "brandId": "d4e5f6a7-b8c9-0123-defa-234567890123",
    "brandDisplayName": "Porsche",
    "modelName": "911 GT3 Cup",
    "carClassId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "carClassDisplayName": "GT3",
    "enabled": true,
    "createdAt": "2024-02-10T09:00:00Z",
    "updatedAt": "2024-05-20T14:15:00Z"
  }
]

List cars (paged)

Public endpoint — no authentication required.

Returns enabled cars in a paginated response. Default page size is 20, sorted by modelName.

GET /api/v1/cars/paged

Query parameters

number

default:"0"

Zero-based page index.

number

default:"20"

Number of items per page.

string

default:"modelName"

Field and direction, e.g. modelName,asc.

Example request

cURL

curl "https://chrono.pitpath.de/api/v1/cars/paged?page=0&size=20" \
  -H "X-API-Key: YOUR_API_KEY"

Get a car

Public endpoint — no authentication required.

Returns a single car by its UUID.

GET /api/v1/cars/{carId}

Path parameters

string (UUID)

required

The UUID of the car to retrieve.

Example request

cURL

curl https://chrono.pitpath.de/api/v1/cars/c3d4e5f6-a7b8-9012-cdef-123456789012 \
  -H "X-API-Key: YOUR_API_KEY"

Create a car

Requires CRUD+ role.

Creates a new car. You must supply a valid brandId and carClassId that already exist in the system.

POST /api/v1/cars

Request body

string (UUID)

required

UUID of the manufacturer brand.

string

required

Car model name (1–120 characters).

string (UUID)

required

UUID of the performance class.

boolean

Whether the car appears in public listings. Defaults to true.

Example request

cURL

curl -X POST https://chrono.pitpath.de/api/v1/cars \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brandId": "d4e5f6a7-b8c9-0123-defa-234567890123",
    "modelName": "911 GT3 Cup",
    "carClassId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "enabled": true
  }'

Update a car

Requires CRUD+ role.

Partially updates an existing car. Only the fields you include are changed.

PATCH /api/v1/cars/{carId}

Path parameters

string (UUID)

required

The UUID of the car to update.

Request body

string (UUID)

UUID of the new manufacturer brand.

string

New model name (1–120 characters).

string (UUID)

UUID of the new performance class.

boolean

Set to false to hide the car from public listings.

Example request

cURL

curl -X PATCH https://chrono.pitpath.de/api/v1/cars/c3d4e5f6-a7b8-9012-cdef-123456789012 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Car brand object

A car brand represents a vehicle manufacturer such as Porsche, Ferrari, or BMW.

string (UUID)

required

Unique identifier for the car brand.

string

required

Manufacturer name (3–120 characters).

string

required

URL-safe identifier (2–20 characters).

string

required

CDN key for the manufacturer logo asset (max 255 characters).

boolean

Whether the logo is an SVG file.

string

required

ISO 3166-1 alpha-3 country code of the manufacturer’s home country.

boolean

Whether the brand appears in public listings.

string (ISO 8601)

Timestamp when the brand was created.

string (ISO 8601)

Timestamp of the most recent update.

List car brands

Public endpoint — no authentication required.

GET /api/v1/car-brands

Example request

cURL

curl https://chrono.pitpath.de/api/v1/car-brands \
  -H "X-API-Key: YOUR_API_KEY"

List car brands (paged)

Public endpoint — no authentication required.

GET /api/v1/car-brands/paged

Get a car brand

Public endpoint — no authentication required.

GET /api/v1/car-brands/{carBrandId}

string (UUID)

required

The UUID of the car brand.

Create a car brand

Requires CRUD+ role.

POST /api/v1/car-brands

Request body

string

required

Manufacturer name (3–120 characters).

string

required

URL-safe identifier (2–20 characters).

string

required

CDN key for the logo asset (max 255 characters).

boolean

Whether the logo is an SVG file.

string

required

ISO 3166-1 alpha-3 country code (exactly 3 characters, e.g. "DEU").

boolean

Defaults to true.

Example request

cURL

curl -X POST https://chrono.pitpath.de/api/v1/car-brands \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Porsche",
    "slug": "porsche",
    "logo": "BRAND/porsche.svg",
    "svg": true,
    "country": "DEU",
    "enabled": true
  }'

Update a car brand

Requires CRUD+ role.

PATCH /api/v1/car-brands/{carBrandId}

string (UUID)

required

The UUID of the car brand to update.

Request body — all fields are optional.

string

New name (3–120 characters).

string

New URL-safe identifier (2–20 characters).

string

New CDN key for the logo (max 255 characters).

boolean

Whether the new logo is an SVG file.

string

New ISO 3166-1 alpha-3 country code (exactly 3 characters).

boolean

Set to false to hide from public listings.

Car class object

A car class groups vehicles by performance category, for example GT3, GT4, or Prototype.

string (UUID)

required

Unique identifier for the car class.

string

required

Full class name (2–120 characters).

string

required

Abbreviated class name (2–20 characters).

string

required

CDN key for the class logo (max 255 characters).

boolean

Whether the logo is an SVG file.

boolean

Whether the class appears in public listings.

string (ISO 8601)

Timestamp when the class was created.

string (ISO 8601)

Timestamp of the most recent update.

List car classes

Public endpoint — no authentication required.

GET /api/v1/car-classes

Example request

cURL

curl https://chrono.pitpath.de/api/v1/car-classes \
  -H "X-API-Key: YOUR_API_KEY"

List car classes (paged)

Public endpoint — no authentication required.

GET /api/v1/car-classes/paged

Get a car class

Public endpoint — no authentication required.

GET /api/v1/car-classes/{carClassId}

string (UUID)

required

The UUID of the car class.

Create a car class

Requires CRUD+ role.

POST /api/v1/car-classes

Request body

string

required

Full class name (2–120 characters).

string

required

Abbreviated name (2–20 characters).

string

required

CDN key for the class logo (max 255 characters).

boolean

Whether the logo is an SVG file.

boolean

Defaults to true.

Example request

cURL

curl -X POST https://chrono.pitpath.de/api/v1/car-classes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "GT3",
    "shortName": "GT3",
    "logo": "CLASS/gt3.svg",
    "svg": true,
    "enabled": true
  }'

Update a car class

Requires CRUD+ role.

PATCH /api/v1/car-classes/{carClassId}

string (UUID)

required

The UUID of the car class to update.

Request body — all fields are optional.

string

New full class name (2–120 characters).

string

New abbreviated name (2–20 characters).

string

New CDN key for the logo (max 255 characters).

boolean

Whether the new logo is an SVG file.

boolean

Set to false to hide from public listings.

Example request

cURL

curl -X PATCH https://chrono.pitpath.de/api/v1/car-classes/e5f6a7b8-c9d0-1234-efab-345678901234 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shortName": "GT3-Cup"}'

Overview

Endpoints

Cars API — vehicle catalog and classes

Car object

List cars

List cars (paged)

Get a car

Create a car

Update a car

Car brand object

List car brands

List car brands (paged)

Get a car brand

Create a car brand

Update a car brand

Car class object

List car classes

List car classes (paged)

Get a car class

Create a car class

Update a car class

​Car object

​List cars

​List cars (paged)

​Get a car

​Create a car

​Update a car

​Car brand object

​List car brands

​List car brands (paged)

​Get a car brand

​Create a car brand

​Update a car brand

​Car class object

​List car classes

​List car classes (paged)

​Get a car class

​Create a car class

​Update a car class

Car object

List cars

List cars (paged)

Get a car

Create a car

Update a car

Car brand object

List car brands

List car brands (paged)

Get a car brand

Create a car brand

Update a car brand

Car class object

List car classes

List car classes (paged)

Get a car class

Create a car class

Update a car class