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

# Get partner configuration

> Returns the current partner configuration including webhook endpoints, telephony setup, agent limits, and allowed voices/languages. Sensitive values are masked.



## OpenAPI

````yaml /openapi.json get /config
openapi: 3.1.0
info:
  title: Vocobase Partner API
  version: '2.0'
  description: >-
    API for managing voice AI agents, documents, and calls on the Vocobase
    platform.
servers:
  - url: https://api.vocobase.com/api/v2
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Config
    description: >-
      Read and update partner configuration, webhook settings, and telephony
      credentials.
  - name: Agents
    description: Create, read, update, and delete voice AI agents.
  - name: Voices
    description: >-
      List voice tiers, available voices, and stream preview audio for agent
      configuration.
  - name: Documents
    description: Upload, manage, and delete knowledge base documents.
  - name: Agent Documents
    description: Link and unlink documents to agents for knowledge base integration.
  - name: Calls
    description: Initiate outbound calls and view call history.
  - name: Phone Numbers
    description: >-
      Import DIDs, assign agents for inbound routing, and re-sync carrier
      Application bindings.
  - name: Inbound Routing Policies
    description: >-
      Define pre-answer routing decisions for inbound calls before AI sessions
      are created.
  - name: Telephony Connections
    description: Create, list, rename, and disconnect named V2 telephony connections.
  - name: VoiceLink Management
    description: Manage VoiceLink reseller clients, DID mapping, and readiness sync.
  - name: Projects
    description: Organize agents into projects. Every agent belongs to exactly one project.
  - name: Dictionaries
    description: Speech-recognition dictionary CRUD and agent attachment.
  - name: Sessions
    description: Browser-initiated WebRTC voice sessions for in-app voice agents.
paths:
  /config:
    get:
      tags:
        - Config
      summary: Get partner configuration
      description: >-
        Returns the current partner configuration including webhook endpoints,
        telephony setup, agent limits, and allowed voices/languages. Sensitive
        values are masked.
      operationId: getConfig
      responses:
        '200':
          description: Partner configuration retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    $ref: '#/components/schemas/PartnerConfig'
              example:
                success: true
                data:
                  name: acme-corp
                  display_name: Acme Corporation
                  agent_limit: 10
                  current_agent_count: 3
                  allowed_voices:
                    - voice-id-1
                    - voice-id-2
                  allowed_languages:
                    - en
                    - hi
                    - es
                  status: active
                  webhook:
                    configured: true
                    url: https://example.com/webhook
                    secret: '****'
                  webhooks:
                    - id: 12345678-abcd-1234-abcd-123456789012
                      label: prod
                      url: https://example.com/webhooks/vocobase
                      enabled: true
                      last_delivery_at: '2026-05-25T10:30:00.000Z'
                      last_delivery_status: 200
                      created_at: '2026-05-25T10:00:00.000Z'
                      updated_at: '2026-05-25T10:30:00.000Z'
                  allowed_telephony_providers:
                    - twilio
                    - exotel
                  telephony:
                    twilio:
                      configured: true
                      account_sid: conf****ured
                      from_number: '+14155551234'
                    mcube:
                      configured: false
                      exe_number: null
                    exotel:
                      configured: true
                      account_sid: conf****ured
                      subdomain: api.exotel.com
                      caller_id: '+919876543210'
                      applet_id: app_****
                    plivo:
                      configured: false
                      auth_id: null
                      from_number: null
                    vobiz:
                      configured: false
                      auth_id: null
                      from_number: null
                  created_at: '2025-01-15T10:30:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PartnerConfig:
      type: object
      properties:
        name:
          type: string
          description: Internal partner name (slug).
        display_name:
          type: string
          description: Human-readable display name.
        agent_limit:
          type: integer
          description: Maximum number of agents allowed.
        current_agent_count:
          type: integer
          description: Current number of active agents.
        allowed_voices:
          type: array
          items:
            type: string
          description: Voice IDs available to this partner.
        allowed_languages:
          type: array
          items:
            type: string
          description: Language codes available to this partner.
        status:
          type: string
          enum:
            - active
            - suspended
        allowed_telephony_providers:
          type: array
          items:
            type: string
            enum:
              - mcube
              - twilio
              - exotel
              - plivo
              - vobiz
              - tata_smartflo
              - sip
              - voicelink
          description: >-
            Providers this partner is allowed to use when starting calls.
            Managed by Vocobase platform admins.
        webhook:
          type: object
          properties:
            configured:
              type: boolean
            url:
              type:
                - string
                - 'null'
              format: uri
            secret:
              type:
                - string
                - 'null'
              description: Always masked as `****` when configured.
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/PartnerWebhookEndpoint'
          description: >-
            Configured webhook endpoints. Endpoint secrets are never returned by
            config reads.
        telephony:
          type: object
          properties:
            twilio:
              type: object
              properties:
                configured:
                  type: boolean
                account_sid:
                  type:
                    - string
                    - 'null'
                  description: Masked when configured.
                from_number:
                  type:
                    - string
                    - 'null'
            mcube:
              type: object
              properties:
                configured:
                  type: boolean
                exe_number:
                  type:
                    - string
                    - 'null'
                source:
                  type:
                    - string
                    - 'null'
                  enum:
                    - connection
                    - legacy_partner_config
                    - null
                  description: >-
                    Where the active MCube credentials come from. New
                    integrations should use telephony connections.
            exotel:
              type: object
              properties:
                configured:
                  type: boolean
                account_sid:
                  type:
                    - string
                    - 'null'
                  description: Masked when configured.
                subdomain:
                  type:
                    - string
                    - 'null'
                caller_id:
                  type:
                    - string
                    - 'null'
                applet_id:
                  type:
                    - string
                    - 'null'
            plivo:
              type: object
              properties:
                configured:
                  type: boolean
                auth_id:
                  type:
                    - string
                    - 'null'
                  description: Masked when configured.
                from_number:
                  type:
                    - string
                    - 'null'
            vobiz:
              type: object
              properties:
                configured:
                  type: boolean
                auth_id:
                  type:
                    - string
                    - 'null'
                  description: Masked when configured.
                from_number:
                  type:
                    - string
                    - 'null'
            voicelink:
              type: object
              properties:
                configured:
                  type: boolean
                allowed:
                  type: boolean
                  description: Whether `voicelink` is in allowed_telephony_providers.
                username:
                  type:
                    - string
                    - 'null'
                  description: VoiceLink panel username (non-secret).
                base_url:
                  type:
                    - string
                    - 'null'
                from_number:
                  type:
                    - string
                    - 'null'
                  description: Default outbound DID.
        created_at:
          type: string
          format: date-time
    PartnerWebhookEndpoint:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Webhook endpoint ID.
        label:
          type: string
          description: Partner-chosen endpoint label.
        url:
          type: string
          format: uri
          description: HTTPS endpoint URL.
        enabled:
          type: boolean
          description: Whether this endpoint receives new webhook events.
        last_delivery_at:
          type:
            - string
            - 'null'
          format: date-time
        last_delivery_status:
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          const: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or missing API key
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: INTERNAL_ERROR
              message: An unexpected error occurred
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key in format: `rg_live_xxxx`. Pass as a Bearer token in the
        Authorization header.

````