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

# Get the organization a token acts in

> Returns the organization named by `X-RootKey-Organization` as the token sees it: its name, its agent mode and the scopes the token effectively has there. It needs the `rootkey.read` scope. When the organization does not allow the request, the answer is the `403` whose `errorCode` says why, so this is the call to make first to find out whether a token can work in an organization. Only a personal access token can call it: a request with an API key gets the `404` that any path the API does not have gets.



## OpenAPI

````yaml get /organization
openapi: 3.0.3
info:
  title: ROOTKey Documentation
  description: >-
    Your API of choice for creating, managing, and validating information easily
    and securely!
  termsOfService: https://www.rootkey.ai/legal/privacy-policy
  contact:
    name: ROOTKey
    url: https://www.rootkey.ai/contact
    email: support@rootkey.ai
  version: 1.0.0
servers:
  - description: Production
    url: https://api.rootkey.ai/api-v1/
security:
  - x-api-key: []
  - personalAccessToken: []
tags:
  - name: api-v1-public
    description: Unauthenticated top-level /api-v1 endpoints (health, plans, annual report)
  - name: api-v1-files
    description: >-
      File anchoring, versioning, validation and compliance reporting
      (/api-v1/platform/files)
  - name: api-v1-records
    description: Structured-data record anchoring (/api-v1/platform/records)
  - name: api-v1-vaults
    description: 'Vault lifecycle: create / update / delete (/api-v1/platform/vaults)'
  - name: api-v1-recovery-points
    description: >-
      Backup archives created from vault contents
      (/api-v1/platform/recovery-point)
  - name: api-v1-organizations
    description: >-
      The identity of a personal access token and the organizations it can act
      in (/api-v1/me, /api-v1/organizations, /api-v1/organization)
paths:
  /organization:
    get:
      tags:
        - api-v1-organizations
      summary: Get the organization a token acts in
      description: >-
        Returns the organization named by `X-RootKey-Organization` as the token
        sees it: its name, its agent mode and the scopes the token effectively
        has there. It needs the `rootkey.read` scope. When the organization does
        not allow the request, the answer is the `403` whose `errorCode` says
        why, so this is the call to make first to find out whether a token can
        work in an organization. Only a personal access token can call it: a
        request with an API key gets the `404` that any path the API does not
        have gets.
      parameters:
        - $ref: '#/components/parameters/OrganizationHeader'
        - $ref: '#/components/parameters/TestModeHeader'
      responses:
        '200':
          description: The organization as the token sees it
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentOrganization'
        '400':
          description: >-
            The `X-RootKey-Organization` header is missing
            (`organization_header_required`), or an `x-api-key` sent together
            with `Authorization: Bearer rk_...` (`conflicting_credentials`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainErrorResponse'
        '401':
          description: >-
            Unauthenticated. A missing, malformed, unknown, inactive, revoked or
            expired credential all get the same answer.
        '403':
          $ref: '#/components/responses/AgentAccessDenied'
        '404':
          description: 'An API key was used: this endpoint is for personal access tokens.'
        '429':
          description: >-
            Too many requests. The `Retry-After` header says how many seconds to
            wait. See [Rate Limits](/pages/rate-limits).
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - personalAccessToken: []
components:
  parameters:
    OrganizationHeader:
      name: X-RootKey-Organization
      in: header
      required: false
      schema:
        type: string
      description: >-
        The organization a personal access token acts in: the `id` of one of the
        organizations that `GET /organizations` lists. Required with a personal
        access token on every endpoint that works inside an organization;
        without it the request gets `organization_header_required`. Ignored with
        an API key, which belongs to exactly one organization.
    TestModeHeader:
      name: x-test-mode
      in: header
      required: false
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
        default: 'false'
      description: >-
        Whether a personal access token works on live data (`false`, the
        default) or on test data (`true`). Only this header decides, never a
        query string or a body field. An API key is itself a test or a live key
        and works on that data.
  schemas:
    AgentOrganization:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        mode:
          $ref: '#/components/schemas/AgentOrganizationMode'
        effectiveScopes:
          type: array
          items:
            type: string
            enum:
              - rootkey.read
              - rootkey.write
              - rootkey.delete
          description: >-
            The token's own scopes narrowed by what the organization allows now:
            none when agents are disabled, when the user is blocked, when the
            organization requires two-factor authentication and the user has
            none, or when it does not allow personal access tokens; only
            `rootkey.read` (when the token has it) in a read-only organization;
            the token's scopes otherwise. It never adds a scope the token does
            not hold. The user's role can still refuse an individual request.
    DomainErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            requestId:
              type: string
            message:
              type: string
            errorCode:
              type: string
            docUrl:
              type: string
            timestamp:
              type: string
              format: date-time
    AgentOrganizationMode:
      type: string
      enum:
        - DISABLED
        - READ_ONLY
        - FULL
      description: >-
        What the organization lets agents do: `DISABLED` serves no agent
        request, `READ_ONLY` only reads, `FULL` reads, writes and deletes. An
        organization that never saved a policy is `READ_ONLY`.
  responses:
    AgentAccessDenied:
      description: >-
        Forbidden. With a personal access token, the organization, the user or
        the token does not allow the request, and the `errorCode` says which:
        `agent_org_not_allowed`, `agent_user_blocked`,
        `agent_two_factor_required`, `agent_access_disabled`,
        `agent_write_not_allowed`, `agent_personal_tokens_disabled`,
        `insufficient_scope`, `insufficient_permission`,
        `agent_restricted_data_denied` or `email_verification_required`. A user
        who is not a member of the organization, or a network an IP access rule
        blocks, gets `access_policy_denied`. Each code has an entry on the
        [Errors](/api-reference/errors) page.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DomainErrorResponse'
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        ROOTKey API key. A test key works on your organization's test data and a
        live key on its live data; both are used with the same API.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: rk_pat_...
      description: >-
        Personal access token of a ROOTKey user, sent as `Authorization: Bearer
        rk_pat_...`. A token acts as the user who created it, in the
        organization named by the `X-RootKey-Organization` header, and never
        with more access than that user has in the ROOTKey app: the
        organization's agent policy, the user's own role and teams, and the
        token's scopes (`rootkey.read`, `rootkey.write`, `rootkey.delete`) all
        apply. A missing, malformed, unknown, revoked or expired token gets the
        same `401`. Send either an `x-api-key` or a bearer token, never both: a
        request with both gets `conflicting_credentials`. See
        [Authentication](/api-reference/auth).

````

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