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

# Get current API key

> Requires a valid active partner API key. No feature scope is required.



## OpenAPI

````yaml /api-reference/openapi.json get /whoami
openapi: 3.1.0
info:
  title: Digital Florists Partner API
  version: v1
  description: >-
    Orders, customers and products (reads plus customer creation) and outbound
    webhooks. Bearer authentication; per-shop base URL.
servers:
  - url: https://{shop_domain}/api/partner/v1
    description: Shop
    variables:
      shop_domain:
        default: your-shop.example
security:
  - bearerAuth: []
paths:
  /whoami:
    get:
      tags:
        - Authentication
      summary: Get current API key
      description: Requires a valid active partner API key. No feature scope is required.
      operationId: partner.v1.whoami
      responses:
        '200':
          description: The authenticated API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerApiIdentity'
              examples:
                success:
                  summary: Example response
                  value:
                    id: 12
                    name: Partner integration
                    scopes:
                      - partner.orders.read
                      - partner.customers.read
                    tenant:
                      ref: 440db2ce-91eb-4c1b-8c84-226c0f6fb4cc
                    expires_at: '2026-09-25T23:59:59+01:00'
        '401':
          $ref: '#/components/responses/AuthenticationException'
          description: >-
            Authentication failed, or the token is missing, invalid, expired, or
            revoked.
        '403':
          $ref: '#/components/responses/ForbiddenError'
          description: >-
            The token lacks the required scope, or API access is not enabled for
            this shop.
        '429':
          $ref: '#/components/responses/RateLimitError'
          description: >-
            Rate limit exceeded. Retry after the period given in the Retry-After
            header.
        '500':
          $ref: '#/components/responses/ServerError'
          description: An unexpected server error occurred.
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
          description: The partner API is temporarily disabled. Retry later.
      security:
        - bearerAuth: []
components:
  schemas:
    PartnerApiIdentity:
      type: object
      properties:
        id:
          type: integer
          example: 12
        name:
          type: string
          example: Partner integration
        scopes:
          type: array
          items:
            type: string
            enum:
              - partner.orders.read
              - partner.customers.read
              - partner.customers.pii
              - partner.products.read
              - partner.webhooks.manage
              - partner.customers.write
          example:
            - partner.orders.read
            - partner.customers.read
        tenant:
          type: object
          properties:
            ref:
              type: string
              example: 440db2ce-91eb-4c1b-8c84-226c0f6fb4cc
          required:
            - ref
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-09-25T23:59:59+01:00'
      required:
        - id
        - name
        - scopes
        - tenant
        - expires_at
      title: PartnerApiIdentity
      example:
        id: 12
        name: Partner integration
        scopes:
          - partner.orders.read
          - partner.customers.read
        tenant:
          ref: 440db2ce-91eb-4c1b-8c84-226c0f6fb4cc
        expires_at: '2026-09-25T23:59:59+01:00'
  responses:
    AuthenticationException:
      description: Unauthenticated
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                description: Stable machine-readable error code.
              message:
                type: string
                description: Human-readable error overview.
            required:
              - error
              - message
    ForbiddenError:
      description: >-
        The token lacks the required scope, or API access is not enabled for
        this shop.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                description: Stable machine-readable error code.
              message:
                type: string
                description: Human-readable error overview.
            required:
              - error
              - message
    RateLimitError:
      description: >-
        Rate limit exceeded. Retry after the period given in the Retry-After
        header.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                description: Stable machine-readable error code.
              message:
                type: string
                description: Human-readable error overview.
              retry_after:
                type:
                  - integer
                  - 'null'
                description: Seconds to wait before retrying.
            required:
              - error
              - message
              - retry_after
    ServerError:
      description: An unexpected server error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                description: Stable machine-readable error code.
              message:
                type: string
                description: Human-readable error overview.
            required:
              - error
              - message
    ServiceUnavailableError:
      description: The partner API is temporarily disabled. Retry later.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                description: Stable machine-readable error code.
              message:
                type: string
                description: Human-readable error overview.
            required:
              - error
              - message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````