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

# Get Workspace

> Get workspace information, usage limits, and credit balance.



## OpenAPI

````yaml get /workspace
openapi: 3.1.0
info:
  title: Geogen API
  description: >-
    API for accessing LLM visibility data, managing entities, and tracking AI
    mentions.
  version: 1.0.0
servers:
  - url: https://api.geogen.io/v1
    description: Production server
security:
  - bearerAuth: []
paths:
  /workspace:
    get:
      tags:
        - Workspace
      summary: Get Workspace
      description: Get workspace information, usage limits, and credit balance.
      operationId: getWorkspace
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      workspace:
                        $ref: '#/components/schemas/Workspace'
                      subscription:
                        $ref: '#/components/schemas/Subscription'
                      usage:
                        type: object
                        properties:
                          entities:
                            $ref: '#/components/schemas/UsageItem'
                          prompts:
                            $ref: '#/components/schemas/UsageItem'
                          teamMembers:
                            $ref: '#/components/schemas/UsageItem'
                          credits:
                            $ref: '#/components/schemas/Credits'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          description: Workspace ID
        name:
          type: string
          description: Workspace name
    Subscription:
      type: object
      properties:
        planName:
          type: string
          description: Name of the subscription plan
        status:
          type: string
          description: Subscription status
        expiresAt:
          type: number
          description: Expiration timestamp in milliseconds
    UsageItem:
      type: object
      properties:
        used:
          type: number
          description: Current usage count
        limit:
          type: number
          nullable: true
          description: Maximum allowed by plan
    Credits:
      type: object
      properties:
        balance:
          type: number
          description: Current credit balance
        totalUsed:
          type: number
          description: Total credits used
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'API key authentication. Format: Bearer wsk_your_api_key'

````