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

# Get Platform Settings

> Returns the current settings for your Platform, including auto-earn configuration, default chain, and webhook URL.



## OpenAPI

````yaml GET /platform/settings
openapi: 3.1.0
info:
  title: Otim Platform API
  version: v0
  description: >-
    API for managing accounts, entities, transfers, counterparties, and IBANs on
    the Otim platform.
servers:
  - url: https://api.otim.com/v0
security:
  - bearerAuth: []
paths:
  /platform/settings:
    get:
      tags: []
      summary: Get Platform Settings
      description: >-
        Returns the current settings for your Platform, including auto-earn
        configuration, default chain, and webhook URL.
      operationId: getPlatformSettings
      responses:
        '200':
          description: Platform settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformSettings'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PlatformSettings:
      type: object
      properties:
        autoEarnEnabled:
          type: boolean
          description: >-
            When enabled, new Accounts are automatically configured to earn
            yield on idle balances.
          example: true
        autoEarnVault:
          type: string
          nullable: true
          description: >-
            The vault used for auto-earn. When auto-earn is enabled, idle
            balances in new Accounts are deposited into this vault.
          enum:
            - aave_usdc
            - morpho_usdc
            - sky_usds
          example: aave_usdc
        defaultChain:
          type: string
          description: The default chain used when creating new Accounts.
          example: base
        webhookUrl:
          type: string
          nullable: true
          description: URL to receive webhook notifications for events on your Platform.
          example: https://yourapp.com/webhooks/otim
        updatedAt:
          type: string
          format: date-time
          example: '2025-01-15T12:00:00Z'
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: A machine-readable error code.
        details:
          type: object
          nullable: true
          description: Additional context about the error.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key prefixed with `sk_`.

````