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

# Self-describe: partner identity + resolved scope list

> Return the calling partner's identity and full resolved granted scopes.

This is the one endpoint with no single declared scope (V2_API_DESIGN §2.1):
any valid key may call it. It is the first call any partner makes and the
hook for a future MCP wrapper.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partners/me
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/partners/me:
    get:
      tags:
        - partners
      summary: 'Self-describe: partner identity + resolved scope list'
      description: >-
        Return the calling partner's identity and full resolved granted scopes.


        This is the one endpoint with no single declared scope (V2_API_DESIGN
        §2.1):

        any valid key may call it. It is the first call any partner makes and
        the

        hook for a future MCP wrapper.
      operationId: get_partners_me_api_v2_partners_me_get
      parameters:
        - 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/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: '`GET /api/v2/partners/me` — self-describe (V2_API_DESIGN §2.1).'
    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.

````