List ships

Returns ships in the order they registered. Use cursor to page.

GET /ships

Authorization

bearerAuth Authorization: Bearer <token>

Any token will do here. Without one the answer is a 401.

Query parameters

type? string

Only ships of this type.

Value in cargo tanker ferry tug

limit? integer

How many to return.

Range 1 ≤ value ≤ 100 Default 25

cursor? string

Where the last page ended.

Responses

200 A page of ships. application/json

data? array<Ship>

Properties

name* string

Range 2 ≤ value ≤ 80

type* string

What the ship carries.

Value in cargo tanker ferry tug

id? integer

Format int64

tonnage? number

Gross tonnage.

Format float Range 0 ≤ value ≤ 500000

captain? object

Whoever is in command right now.

Properties

name* string

licence? string

Pattern ^[A-Z]{2}\d{6}$

crew? array<object>

Properties

name? string

role? string

Value in deck engine galley

escort? Ship

Repeats Ship

registeredAt? string

Format date-time

next? string | null

Cursor for the next page.

Request

curl -X GET 'https://vellum.jimmyverburgt.com/harbor/v2/ships' \
  -H 'Authorization: Bearer <token>'

$response = Http::withToken('<token>')->get('https://vellum.jimmyverburgt.com/harbor/v2/ships');

const response = await fetch('https://vellum.jimmyverburgt.com/harbor/v2/ships', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
  }
})

Response

{
    "data": [
        {
            "id": 1,
            "name": "Aurora",
            "type": "cargo",
            "tonnage": 48200,
            "captain": {
                "name": "Ada Vos",
                "licence": "NL204518"
            },
            "crew": [
                {
                    "name": "Tomas Lind",
                    "role": "deck"
                }
            ],
            "registeredAt": "2026-01-31T09:00:00Z"
        }
    ],
    "next": "string"
}