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

# Get workspace settings

> Returns the workspace settings. The Resend API key is masked.



## OpenAPI

````yaml https://folksbase.onrender.com/api/openapi.json get /api/settings
openapi: 3.1.0
info:
  title: folksbase API
  description: >-
    Contact management API for folksbase. Upload CSVs, manage contacts and tags,
    export data.
  version: 1.0.0
servers:
  - url: https://folksbase.onrender.com
    description: Production
  - url: http://localhost:3001
    description: Local development
security:
  - bearerAuth: []
paths:
  /api/settings:
    get:
      tags:
        - Settings
      summary: Get workspace settings
      description: Returns the workspace settings. The Resend API key is masked.
      operationId: getApiSettings
      responses:
        '200':
          description: Workspace settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspace_id:
                    type: string
                    format: uuid
                    pattern: >-
                      ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                  resend_api_key:
                    anyOf:
                      - type: string
                      - type: 'null'
                  notify_on_import_complete:
                    type: boolean
                  notify_on_export_complete:
                    type: boolean
                  notify_weekly_digest:
                    type: boolean
                required:
                  - workspace_id
                  - resend_api_key
                  - notify_on_import_complete
                  - notify_on_export_complete
                  - notify_weekly_digest
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Supabase JWT token from Authorization header

````