> ## Documentation Index
> Fetch the complete documentation index at: https://docs.crewpass.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Fleet dashboard: crew on attached vessels (scope: vessels:fleet:read)

> Every crew member on the partner's attached vessels, paginated.

Per crew, ``status`` is included only when ``crew:status:read`` is effective
(granted ∩ consented) for that crew — the endpoint's second scope, applied
as a per-crew consent intersection. ``documents_expiring`` counts current
documents expiring within the requested window.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/employers/me/fleet
openapi: 3.1.0
info:
  title: crewpass-api-v2
  description: >-
    CrewPass V2 Partner API — a scope-gated, consent-intersected, multi-tenant
    front door onto existing CrewPass crew/vessel/compliance data.
  version: 0.1.0
servers: []
security: []
paths:
  /api/v2/employers/me/fleet:
    get:
      tags:
        - employers
      summary: 'Fleet dashboard: crew on attached vessels (scope: vessels:fleet:read)'
      description: >-
        Every crew member on the partner's attached vessels, paginated.


        Per crew, ``status`` is included only when ``crew:status:read`` is
        effective

        (granted ∩ consented) for that crew — the endpoint's second scope,
        applied

        as a per-crew consent intersection. ``documents_expiring`` counts
        current

        documents expiring within the requested window.
      operationId: fleet_api_v2_employers_me_fleet_get
      parameters:
        - name: include_documents_expiring_within_days
          in: query
          required: false
          schema:
            type: integer
            maximum: 730
            minimum: 0
            default: 30
            title: Include Documents Expiring Within Days
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 50
            title: Limit
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - name: X-Partner-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Partner-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FleetResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - PartnerApiKey: []
components:
  schemas:
    FleetResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/FleetCrewItem'
          type: array
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
        expiring_within_days:
          type: integer
          title: Expiring Within Days
      type: object
      required:
        - items
        - expiring_within_days
      title: FleetResponse
      description: '`GET /employers/me/fleet` — paginated crew across all attached vessels.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FleetCrewItem:
      properties:
        crew_unique_id:
          type: string
          title: Crew Unique Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        vessel_id:
          type: string
          title: Vessel Id
        vessel_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Vessel Name
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        background_check_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Background Check Status
        documents_expiring:
          type: integer
          title: Documents Expiring
          default: 0
        as_of:
          type: string
          format: date-time
          title: As Of
      type: object
      required:
        - crew_unique_id
        - vessel_id
        - as_of
      title: FleetCrewItem
      description: One crew member on an attached vessel (V2_API_DESIGN §2.8 fleet shape).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    PartnerApiKey:
      type: http
      scheme: bearer
      description: Partner API key (`cpk_live_*` / `cpk_test_*`) as a Bearer token.

````