List your vessels - CrewPass Partner API

Your fleet is the set of vessels on your CrewPass employer account — the same list your dashboard shows. This is usually the first thing you read: it gives you the vessel_ids you’ll see attached to crew elsewhere.

Requires the vessels:fleet:read capability. Authenticated with your API key as a Bearer token over TLS; reads are not signed (see Authentication).

Get your vessels

cURL

curl -sS "$BASE/api/v2/employers/me/vessels" \
  -H "Authorization: Bearer $CPK_KEY"

Python

import httpx

r = httpx.get(f"{BASE}/api/v2/employers/me/vessels",
              headers={"Authorization": f"Bearer {CPK_KEY}"})
for v in r.json()["items"]:
    print(v["vessel_id"], v["vessel_name"], v["flag_state"])

Response

{
  "items": [
    {
      "vessel_id": "ves_abc",
      "vessel_name": "M/Y Example",
      "imo": "9780987",
      "mmsi": "232003200",
      "flag_state": "Cayman Islands",
      "vessel_type": "M/Y"
    }
  ]
}

Field	What it is
`vessel_id`	The opaque id you’ll use to identify this vessel everywhere else.
`vessel_name`	Display name.
`imo` / `mmsi`	Vessel registration identifiers (strings).
`flag_state`	Flag country.
`vessel_type`	e.g. `M/Y`.

Next

See your crew — the people on these vessels.