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

# Get workspace information

> Retrieve information about the current authenticated workspace, including its ID, name, slug, public page URL, and the configured release change types and roadmap status types



## OpenAPI

````yaml https://api.onset.io/v1/openapi.yml get /workspace
openapi: 3.1.0
info:
  title: Onset API
  description: >-
    RESTful API for managing milestones, releases, subscribers, and webhooks in
    Onset workspace.
  version: 1.0.0
  contact:
    name: Onset Support
    url: https://www.onset.io
    email: support@onset.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.onset.io/v1
    description: API V1
security:
  - bearerAuth: []
  - basicAuth: []
tags:
  - name: Workspace
    description: Workspace management operations
  - name: Milestones
    description: Milestone management operations
  - name: Projects
    description: Project read operations
  - name: Labels
    description: Label read operations
  - name: Contributors
    description: Contributor read operations
  - name: Releases
    description: Release management operations
  - name: Subscribers
    description: Subscriber management operations
  - name: Subscriber Lists
    description: Subscriber list management operations
  - name: Webhooks
    description: Webhook management operations
  - name: Incoming Webhooks
    description: Incoming webhook management operations
paths:
  /workspace:
    get:
      tags:
        - Workspace
      summary: Get workspace information
      description: >-
        Retrieve information about the current authenticated workspace,
        including its ID, name, slug, public page URL, and the configured
        release change types and roadmap status types
      responses:
        '200':
          description: Workspace information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          description: Unique workspace identifier
          example: ws_01hf8k4x7n9m2p3q5r8s9t0v1w
        name:
          type: string
          description: Workspace name
          example: Acme Inc
        slug:
          type: string
          description: Workspace slug
          example: acme-inc
        url:
          type: string
          format: uri
          description: Public changelog page URL for the workspace
        release_change_types:
          type: array
          description: Change types configured for releases in this workspace
          items:
            type: object
            properties:
              id:
                type: string
                description: Change type identifier
              title:
                type: string
                description: Change type label
                example: Added
              color:
                type: string
                description: Change type color
                example: '#22c55e'
        roadmap_status_types:
          type: array
          description: Status types configured for roadmap milestones in this workspace
          items:
            type: object
            properties:
              id:
                type: string
                description: Status identifier
              title:
                type: string
                description: Status label
                example: In progress
              color:
                type: string
                description: Status color
                example: '#3b82f6'
              stage:
                type: string
                description: Stage this status maps to
                enum:
                  - BACKLOG
                  - PLANNED
                  - IN_PROGRESS
                  - COMPLETED
                  - CANCELED
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type: object
          description: Additional error details
      required:
        - error
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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