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

# Get the authenticated principal and selected organization

> Returns the current API key owner and selected GitHub Cloud organization without granting additional permissions. Supports user and agentic organization/workspace API keys. Workspace keys require org_id and existing workspace-admin authorization. Self-hosted and legacy keys are unsupported.



## OpenAPI

````yaml /openapi.json get /v1/me
openapi: 3.0.3
info:
  title: CodeRabbit API spec
  version: 1.0.0
servers:
  - url: https://api.coderabbit.ai
security:
  - ApiKeyAuth: []
paths:
  /v1/me:
    get:
      tags:
        - Identity
      summary: Get the authenticated principal and selected organization
      description: >-
        Returns the current API key owner and selected GitHub Cloud organization
        without granting additional permissions. Supports user and agentic
        organization/workspace API keys. Workspace keys require org_id and
        existing workspace-admin authorization. Self-hosted and legacy keys are
        unsupported.
      operationId: get_me
      parameters:
        - name: org_id
          in: query
          schema:
            type: string
            minLength: 1
            description: >-
              Git-provider organization ID. Required for workspace keys; omit
              for organization keys. This differs from the CodeRabbit
              organization ID in scope.id.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformMe'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - invalid_request
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - unauthenticated
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '403':
          description: '403'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - forbidden
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '404':
          description: '404'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - not_found
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '409':
          description: '409'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - head_changed
                          - conflict
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '412':
          description: '412'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - precondition_failed
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '413':
          description: '413'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - payload_too_large
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '429':
          description: '429'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - rate_limit_exceeded
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '500':
          description: '500'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        enum:
                          - internal_error
                        type: string
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
        '503':
          description: '503'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - unavailable
                      message:
                        type: string
                      retry_after:
                        type: integer
                        minimum: 0
                        maximum: 9007199254740991
                        exclusiveMinimum: true
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - error
                additionalProperties: false
components:
  schemas:
    PlatformMe:
      type: object
      properties:
        principal:
          anyOf:
            - type: object
              properties:
                type:
                  enum:
                    - api_key
                id:
                  type: string
                  minLength: 1
                  description: API key record ID, never the secret key.
                key_type:
                  enum:
                    - user
                    - agentic
                  type: string
                owner:
                  type: object
                  properties:
                    provider_user_id:
                      type: string
                      minLength: 1
                      description: >-
                        Current key owner in the selected provider identity
                        model.
                    role:
                      type: string
                      minLength: 1
                      description: >-
                        Resolved role; not a grant of permission for another
                        operation.
                  required:
                    - provider_user_id
                    - role
                  additionalProperties: false
              required:
                - type
                - id
                - key_type
                - owner
              additionalProperties: false
            - type: object
              properties:
                type:
                  enum:
                    - user
                id:
                  type: string
                  minLength: 1
                  description: >-
                    Authenticated user ID in the connection's sign-in identity
                    model.
                oauth_client_id:
                  type: string
                  minLength: 1
                  description: OAuth client acting for the authenticated user.
                provider_user_id:
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: string
                      nullable: true
                      enum:
                        - null
                  description: >-
                    Verified Git-provider identity, or null for a providerless
                    user.
                role:
                  type: string
                  description: >-
                    Resolved role; not a grant of permission for another
                    operation.
              required:
                - type
                - id
                - oauth_client_id
                - provider_user_id
                - role
              additionalProperties: false
        scope:
          type: object
          properties:
            type:
              enum:
                - organization
            id:
              type: string
              minLength: 1
              description: CodeRabbit organization ID, not the provider organization ID.
            provider:
              type: string
              minLength: 1
            workspace_id:
              anyOf:
                - type: string
                  minLength: 1
                - type: string
                  nullable: true
                  enum:
                    - null
          required:
            - type
            - id
            - provider
            - workspace_id
          additionalProperties: false
      required:
        - principal
        - scope
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-coderabbitai-api-key
      description: >-
        API key for authentication. You can create an API key from the
        CodeRabbit dashboard.

````

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