> ## 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.

# List the crew on your vessels

> Every crew member on your vessels, a page at a time (`limit`, `cursor`).

`status` and `background_check_status` are included only for crew members who
have agreed to share their status with you. `documents_expiring` counts
their current documents that expire within
`include_documents_expiring_within_days` (default 30).

Requires `vessels:fleet:read`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/employers/me/fleet
openapi: 3.1.0
info:
  title: CrewPass Partner API
  description: >-
    Read the crew, vessel, document and compliance data CrewPass holds for the
    crew on your vessels, with each crew member's consent.
  version: 0.1.0
servers: []
security: []
paths:
  /api/v2/employers/me/fleet:
    get:
      tags:
        - Fleet
      summary: List the crew on your vessels
      description: >-
        Every crew member on your vessels, a page at a time (`limit`, `cursor`).


        `status` and `background_check_status` are included only for crew
        members who

        have agreed to share their status with you. `documents_expiring` counts

        their current documents that expire within

        `include_documents_expiring_within_days` (default 30).


        Requires `vessels:fleet:read`.
      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: X-Partner-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Your API key, as an alternative to the `Authorization: Bearer`
              header.
            title: X-Partner-Api-Key
          description: >-
            Your API key, as an alternative to the `Authorization: Bearer`
            header.
      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: >-
        One page of the crew on your vessels. Pass `next_cursor` back as
        `cursor` for the next page.
    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
          description: The crew member's id. Pass it to the other crew endpoints.
        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
        vessel_imo:
          anyOf:
            - type: string
            - type: 'null'
          title: Vessel Imo
          description: >-
            The vessel's IMO number, for matching vessels without relying on
            names. `null` when CrewPass doesn't hold one.
        role:
          anyOf:
            - type: string
            - type: 'null'
          title: Role
          description: Their position on this vessel.
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          description: >-
            Their placement on this vessel, e.g. `active` or `invited`. Included
            only if the crew member shares their status with you.
        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: A crew member on one of your vessels.
    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.

````