GET
/
api
/
v2
/
employers
/
me
/
fleet
Fleet dashboard: crew on attached vessels (scope: vessels:fleet:read)
curl --request GET \
  --url https://partners.crewpass.co.uk/api/v2/employers/me/fleet \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "crew_unique_id": "<string>",
      "vessel_id": "<string>",
      "as_of": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "vessel_name": "<string>",
      "role": "<string>",
      "status": "<string>",
      "background_check_status": "<string>",
      "documents_expiring": 0
    }
  ],
  "expiring_within_days": 123,
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Partner API key (cpk_live_* / cpk_test_*) as a Bearer token.

Headers

authorization
string | null
X-Partner-API-Key
string | null

Query Parameters

include_documents_expiring_within_days
integer
default:30
Required range: 0 <= x <= 730
cursor
string | null
limit
integer
default:50
Required range: 1 <= x <= 200

Response

Successful Response

GET /employers/me/fleet — paginated crew across all attached vessels.

items
FleetCrewItem · object[]
required
expiring_within_days
integer
required
next_cursor
string | null