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

# Get Workspace Settings

> Returns general workspace settings: company profile, timezone, date format, default phone country code, and business hours.



## OpenAPI

````yaml GET /v1/workspaces/{id}/settings
openapi: 3.0.0
info:
  title: Conduit API
  version: 1.0.0
  description: Public API for Conduit.
servers:
  - url: https://api.conduit.ai
    description: Production
security: []
tags:
  - name: meta
    description: Discovery and API metadata endpoints.
  - name: agents
    description: >-
      V2 chat agent configuration, including instructions, skills, triggers, and
      automation behavior.
  - name: contacts
    description: >-
      Contact profile and contact-scoped related resources such as tickets and
      calls.
  - name: workspaces
    description: Workspaces accessible to the current API token.
  - name: escalations
    description: >-
      Chat escalations that require operator review, including message, proposed
      response, and disposition context when available.
  - name: conversations
    description: >-
      Canonical message threads. Use these endpoints to list threads, inspect
      conversation state, read transcripts, and send replies.
  - name: conversation-tags
    description: >-
      Conversation labels, root topics, and subtopics used for classification
      and topic analytics.
  - name: tickets
    description: >-
      Operational queue items tied to conversations, including ticket-scoped
      transcripts and replies.
  - name: calls
    description: Phone call records, transcripts, summaries, and recordings when available.
  - name: reservations
    description: >-
      PMS reservations synced from the workspace's integrations (Hostaway,
      Guesty, Airbnb, etc.), including guest identity, payment status, and stay
      dates.
  - name: appointments
    description: >-
      Scheduled appointments (bookings) backed by the Conduit booking service.
      Exposes allocation context and the upstream booking-service `external_id`.
  - name: helpdesk_tickets
    description: >-
      Helpdesk tickets mirrored from external helpdesk integrations (Zendesk,
      Pylon, Plain), including requester identity and upstream metadata.
  - name: kb
    description: >-
      Knowledge base search and node management. Nodes represent knowledge base
      entries (files or directories), chunks are the indexed retrieval units
      used by search.
  - name: skills
    description: >-
      Workspace agent skills that can be attached to V2 chat agents.
      Sidebar/global-assistant skills are intentionally excluded.
  - name: custom_tools
    description: >-
      Custom code tools: user-authored Python/JavaScript functions executed in a
      sandbox when an agent calls them. Includes a runtimes endpoint describing
      the entrypoint signature, return shape, and available dependencies per
      language.
  - name: inbox_types
    description: >-
      Workspace inbox types. Each id is stable and usable as a message trigger's
      `inboxTypeId` and as the `inbox_type_id` filter on list conversations.
  - name: workflows
    description: >-
      Workspace automation workflows: definitions, executions, and per-execution
      event timelines.
  - name: insights
    description: Aggregated workspace analytics, such as conversation automation rate.
paths:
  /v1/workspaces/{id}/settings:
    get:
      tags:
        - workspaces
      summary: Get workspace settings
      description: >-
        Returns general workspace settings: company profile, timezone, date
        format, default phone country code, and business hours.
      operationId: getWorkspaceSettings
      parameters:
        - schema:
            type: string
            description: Workspace identifier.
            example: j57demo8f8x7c9v0n2q4r6t8y1u3i5o
          required: true
          name: id
          in: path
      responses:
        '200':
          description: Workspace settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      company_name:
                        type: string
                        nullable: true
                      company_website:
                        type: string
                        nullable: true
                      company_size:
                        type: string
                        nullable: true
                      about:
                        type: string
                        nullable: true
                      timezone:
                        type: string
                        nullable: true
                        description: IANA workspace timezone.
                        example: America/New_York
                      date_format:
                        type: string
                        nullable: true
                        enum:
                          - MM/DD/YYYY
                          - DD/MM/YYYY
                      default_phone_country_code:
                        type: string
                        nullable: true
                        example: US
                      business_hours:
                        type: object
                        nullable: true
                        properties:
                          timezone:
                            type: string
                            example: America/New_York
                          days:
                            type: array
                            items:
                              type: object
                              properties:
                                enabled:
                                  type: boolean
                                day:
                                  type: string
                                  enum:
                                    - monday
                                    - tuesday
                                    - wednesday
                                    - thursday
                                    - friday
                                    - saturday
                                    - sunday
                                ranges:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      start:
                                        type: string
                                        example: '09:00'
                                      end:
                                        type: string
                                        example: '17:00'
                                    required:
                                      - start
                                      - end
                              required:
                                - enabled
                                - day
                                - ranges
                        required:
                          - timezone
                          - days
                    required:
                      - company_name
                      - company_website
                      - company_size
                      - about
                      - timezone
                      - date_format
                      - default_phone_country_code
                      - business_hours
                required:
                  - data
                description: >-
                  General workspace settings: company profile, timezone, date
                  format, and business hours.
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                description: Standard error response.
                example:
                  error: Invalid workspace id
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Token
      description: >-
        Conduit API token. Use `Authorization: Bearer <token>`. Read/write
        endpoints require a token with write access.

````