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

# Retrieve the workspace

> Returns the configuration and branding of the workspace associated with the authenticated API key's portal.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/workspaces
openapi: 3.0.0
info:
  contact: {}
  title: Assembly API
  version: 0.0.1
servers:
  - url: https://api.assembly.com
security: []
paths:
  /v1/workspaces:
    get:
      tags:
        - Workspaces
      summary: Retrieve the workspace
      description: >-
        Returns the configuration and branding of the workspace associated with
        the authenticated API key's portal.
      operationId: retrieve-workspace
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace.Workspace'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispatcher.Error'
          description: Workspace configuration could not be resolved
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dispatcher.Error'
          description: Missing or invalid API key
      security:
        - APIKeyHeader: []
components:
  schemas:
    workspace.Workspace:
      properties:
        brandName:
          description: Display name of the brand shown to clients.
          example: Acme Inc.
          type: string
        colorAccent:
          description: Hex accent color used throughout the client portal.
          example: '#3a70e8'
          type: string
        colorSidebarBackground:
          description: Hex color of the client sidebar background.
          example: '#ffffff'
          type: string
        colorSidebarText:
          description: Hex color of the client sidebar text.
          example: '#000000'
          type: string
        font:
          description: Font family used in the client portal.
          example: Inter
          type: string
        fullLogoUrl:
          description: URL of the full logo used for the workspace.
          example: https://cdn.assembly.com/logo.png
          format: uri
          type: string
        id:
          description: Unique identifier of the workspace (portal).
          example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
          format: uuid
          type: string
        industry:
          description: Industry selected for the workspace during onboarding.
          example: Marketing
          type: string
        isClientDirectSignUpEnabled:
          description: Whether clients can sign up directly without an invitation.
          example: false
          type: boolean
        isCompaniesEnabled:
          description: Whether the companies feature is enabled for the workspace.
          example: true
          type: boolean
        labels:
          allOf:
            - $ref: '#/components/schemas/workspace.Labels'
          description: Custom terminology configured for the workspace.
        logOutUrl:
          description: URL clients are redirected to after signing out.
          example: https://example.com/logout
          format: uri
          type: string
        metaDescription:
          description: Page description used in meta tags.
          example: Manage your projects with Acme.
          type: string
        metaTitle:
          description: Page title shown in the browser tab and meta tags.
          example: Acme Client Portal
          type: string
        portalUrl:
          description: Fully qualified URL of the client-facing portal.
          example: clients.acme.com
          format: uri
          type: string
        socialSharingImageUrl:
          description: URL of the image used when the workspace is shared on social media.
          example: https://cdn.assembly.com/social.png
          format: uri
          type: string
        squareIconUrl:
          description: URL of the square icon used for the workspace.
          example: https://cdn.assembly.com/icon.png
          format: uri
          type: string
        squareLoginImageUrl:
          description: URL of the square image shown on the login screen.
          example: https://cdn.assembly.com/login.png
          format: uri
          type: string
      type: object
    dispatcher.Error:
      properties:
        code:
          type: string
        data: {}
        message:
          type: string
      type: object
    workspace.Labels:
      properties:
        groupTerm:
          description: Singular term used for a group of clients (e.g. "Company").
          example: Company
          type: string
        groupTermPlural:
          description: Plural term used for groups of clients (e.g. "Companies").
          example: Companies
          type: string
        individualTerm:
          description: Singular term used for an individual client (e.g. "Client").
          example: Client
          type: string
        individualTermPlural:
          description: Plural term used for individual clients (e.g. "Clients").
          example: Clients
          type: string
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-KEY
      type: apiKey

````