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

# Resolve the workspace behind this API key

> Return the workspace and organization this API key is scoped to.

Every other endpoint takes the workspace implicitly from the key and never
reports which one it resolved to, so an integration holding more than one
key — or storing anything per workspace — cannot tell them apart. This is
the endpoint that answers it.

Everything returned is already established by authenticating the request,
so there is no database read beyond the key lookup every endpoint does.

Authentication: Requires X-API-Key header with valid API key.



## OpenAPI

````yaml get /api/workspace
openapi: 3.1.0
info:
  title: iClear Integrations API
  description: An API for iClear integrations.
  version: 1.0.0
servers:
  - url: https://api.northell.io/nhl/prod/mediamagic-verify-integrations
    description: prod
security: []
paths:
  /api/workspace:
    get:
      tags:
        - workspace
      summary: Resolve the workspace behind this API key
      description: >-
        Return the workspace and organization this API key is scoped to.


        Every other endpoint takes the workspace implicitly from the key and
        never

        reports which one it resolved to, so an integration holding more than
        one

        key — or storing anything per workspace — cannot tell them apart. This
        is

        the endpoint that answers it.


        Everything returned is already established by authenticating the
        request,

        so there is no database read beyond the key lookup every endpoint does.


        Authentication: Requires X-API-Key header with valid API key.
      operationId: get_workspace_api_workspace_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSchema'
      security:
        - apiKey: []
components:
  schemas:
    WorkspaceSchema:
      properties:
        workspaceId:
          type: string
          format: uuid
          title: Workspaceid
          description: Workspace this API key is scoped to
        orgId:
          type: string
          format: uuid
          title: Orgid
          description: Organization that owns the workspace
        orgName:
          type: string
          title: Orgname
          description: Organization display name
        apiKeyName:
          type: string
          title: Apikeyname
          description: >-
            Label given to this API key when it was created. Useful for telling
            several keys apart in an integration's own logs.
      type: object
      required:
        - workspaceId
        - orgId
        - orgName
        - apiKeyName
      title: WorkspaceSchema
      description: >-
        Who the presented API key belongs to.


        Every other endpoint takes the workspace implicitly from the key and
        never

        says which one it resolved to. An integration that holds several keys,
        or

        that stores anything per workspace, has no way to find out — this closes

        that gap. All of it is already known from authenticating the request, so

        the read costs nothing.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key. Format: sk_live_{64 hex chars}'
      x-default: sk_live_your_api_key_here

````

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