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

# Get organization settings

> Returns the organization's settings. Requires Control Hub access.



## OpenAPI

````yaml /openapi.yaml get /orgSettings
openapi: 3.1.0
info:
  title: AsterAgents API
  version: 1.0.0
  description: >
    API for AsterAgents platform operations.


    - **Admin endpoints** (`/admin/*`) require organization admin privileges
    (`org:admin` role)

    - **Agent endpoints** (`/agents`) require agent management permissions or
    `org:admin` role

    - **Knowledge base endpoints** (`/kb/*`) require standard authentication

    - **Skills endpoints** (`/skills/*`) require standard authentication

    - **File endpoints** (`/upload/*`, `/kb/files`, `/skills/files`) require
    standard authentication
  contact:
    name: AsterAgents Support
    url: https://asteragents.com/support
servers:
  - url: https://www.asteragents.com/api
    description: Production
  - url: http://localhost:3000/api
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Manage active organization users
  - name: Invitations
    description: Manage organization invitations
  - name: Files
    description: Upload and manage files
  - name: Knowledge Bases
    description: Manage knowledge bases and their files
  - name: Knowledge Base Management
    description: Create, update, and delete knowledge bases
  - name: Agents
    description: Create, update, and delete agents
  - name: Agent Tags
    description: Organize agents with tags
  - name: Tools
    description: Discover the tool catalog available to your organization
  - name: Skills
    description: Manage agent skills
  - name: Skill Files
    description: Manage bundled files for skills
  - name: Conversations
    description: Invoke agents and retrieve conversation history and messages
  - name: Scheduled Tasks
    description: Schedule agents to run automatically on a cron schedule
  - name: Organization Settings
    description: Read and change organization-wide settings
paths:
  /orgSettings:
    get:
      tags:
        - Organization Settings
      summary: Get organization settings
      description: Returns the organization's settings. Requires Control Hub access.
      operationId: getOrgSettings
      responses:
        '200':
          description: Current settings, plus spend so far in each capped period.
          content:
            application/json:
              schema:
                type: object
                properties:
                  settings:
                    $ref: '#/components/schemas/OrgSettings'
                  spendCapStatus:
                    type: object
        '403':
          description: No Control Hub access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Organization data not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    OrgSettings:
      type: object
      properties:
        asterAgent:
          type: boolean
          description: >-
            Aster, the built-in agent that helps people find the right agent,
            app or page. On unless set to `false`. Admin only.
        defaultAgentId:
          type:
            - integer
            - 'null'
          description: >-
            The agent a new chat starts with. With no default, new chats start
            on Aster when it's on.
        spendCaps:
          type: object
          description: LLM spend caps in USD; `null` clears a period. Admin only.
          properties:
            daily:
              type:
                - number
                - 'null'
            weekly:
              type:
                - number
                - 'null'
            monthly:
              type:
                - number
                - 'null'
        sidebarPinnedAppIds:
          type:
            - array
            - 'null'
          items:
            type: integer
          description: Apps pinned in every member's sidebar, in order. Admin only.
        sidebarLinks:
          type:
            - array
            - 'null'
          description: >-
            Sidebar footer links (http, https or mailto). `null` restores the
            default. Admin only.
          items:
            type: object
            required:
              - label
              - url
            properties:
              label:
                type: string
              url:
                type: string
              icon:
                type: string
        feedbackModal:
          type: object
          properties:
            customHtml:
              type: string
              description: HTML shown in the feedback dialog.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: Bad Request
        details:
          type: array
          items:
            type: object
            additionalProperties: true
  responses:
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Internal Server Error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        JWT token from Clerk authentication.

        Must be from a user with `org:admin` role.

````

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