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

# The calling key's identity, environment and scopes.

> Response is the resource DIRECTLY — no `data` wrapper (see the top-level description's "Response envelope" note).



## OpenAPI

````yaml /openapi/ehr-api.v1.yaml get /v1/me
openapi: 3.1.0
info:
  title: ClinikEHR API
  version: 1.0.0
  description: >-
    Server-to-server REST API for a clinic's own data, reached with a key the
    clinic (or a developer workspace) creates in the developer portal.


    Authenticate every request with `Authorization: Bearer <key>`. Test keys
    reach only your workspace's own synthetic sandbox; live keys reach the
    clinic that created them. Lists wrap their rows as `{ data, has_more,
    next_cursor }`; single resources are returned directly. Errors are
    `application/problem+json` (RFC 9457) with a stable `code`.


    Write requests accept an `Idempotency-Key` header so a retry never repeats a
    change. See the guides for authentication, permissions, pagination, rate
    limits and retries.
servers:
  - url: https://api.clinikehr.com/v1
security:
  - ApiKey: []
paths:
  /v1/me:
    get:
      tags:
        - Me
      summary: The calling key's identity, environment and scopes.
      description: >-
        Response is the resource DIRECTLY — no `data` wrapper (see the top-level
        description's "Response envelope" note).
      operationId: getMe
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
              example:
                key_id: key_01H...
                clinic_id: 45715198-88e4-498c-8271-57e652c60246
                environment: live
                scopes:
                  - inventory.items:read
                  - inventory.availability:read
                org_id: null
                sandbox: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - ApiKey: []
components:
  schemas:
    Me:
      type: object
      required:
        - key_id
        - clinic_id
        - environment
        - scopes
        - org_id
        - sandbox
      properties:
        key_id:
          type: string
        clinic_id:
          type:
            - string
            - 'null'
          format: uuid
        environment:
          type: string
          enum:
            - live
            - test
        scopes:
          type: array
          items:
            type: string
        org_id:
          type:
            - string
            - 'null'
          format: uuid
        sandbox:
          type: boolean
          description: >-
            True when clinic_id above is this key's workspace's synthetic
            sandbox clinic, not a real one. Always false for a clinic-owned key.
    Problem:
      type: object
      description: RFC 9457 application/problem+json.
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - pointer
              - message
            properties:
              pointer:
                type: string
              message:
                type: string
  responses:
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or expired key, or the wrong
        secret.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The key or connection lacks the required scope, the plan does not
        include this resource, the request came from an address this key's IP
        allow-list does not permit, a TEST-environment workspace key asked for a
        clinic_id other than its own workspace's sandbox (`sandbox_only`), or a
        LIVE workspace key asked for a real clinic while its workspace's
        verification has lapsed (`not_verified`) — the response never names
        which addresses ARE allowed, nor which clinic actually is the sandbox.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: Rate limited. See the Retry-After header.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: ehr_live_<keyId>_<secret> or ehr_test_<keyId>_<secret>

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.