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

# Get your API account

> Your API account: its id, name, key mode and the scopes your key has.

Any valid API key can call this. Call it first to check your key works and
to see which endpoints you can use.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partners/me
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/partners/me:
    get:
      tags:
        - Account
      summary: Get your API account
      description: >-
        Your API account: its id, name, key mode and the scopes your key has.


        Any valid API key can call this. Call it first to check your key works
        and

        to see which endpoints you can use.
      operationId: get_partners_me_api_v2_partners_me_get
      parameters:
        - 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/PartnerMe'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - PartnerApiKey: []
components:
  schemas:
    PartnerMe:
      properties:
        partner_id:
          type: string
          title: Partner Id
          examples:
            - prt_123
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
          examples:
            - Example Fleet Management
        partner_type:
          type: string
          enum:
            - customer
            - external
          title: Partner Type
        status:
          type: string
          title: Status
          default: active
        mode:
          type: string
          enum:
            - live
            - test
          title: Mode
        subscription_plan:
          anyOf:
            - type: string
            - type: 'null'
          title: Subscription Plan
          examples:
            - management
        granted_scopes:
          items:
            type: string
          type: array
          title: Granted Scopes
          examples:
            - - crew:status:read
              - crew:profile:read
              - vessels:fleet:read
      type: object
      required:
        - partner_id
        - partner_type
        - mode
      title: PartnerMe
      description: Your API account and the scopes your key has been granted.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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.

````