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

# Get Connection Config

> Returns the configuration schema for a specific connection type, including required credential fields and their types. Use this to understand what parameters are needed when creating a connection of this type.


<span style={{display: "flex", gap: "10px", flexDirection: "row", alignItems: "center"}}>
  <img src="https://cdn.peaka.com/badges/partner-api-key-badge.png" />

  <img src="https://cdn.peaka.com/badges/project-api-key-badge.png" />
</span>


## OpenAPI

````yaml get /connections/config/{connectionType}
openapi: 3.0.1
info:
  title: Peaka Gateway API
  description: Peaka Gateway API Documentation
  version: '1.0'
servers:
  - url: https://partner.peaka.studio/api/v1
    description: Default Server URL (US Zone)
  - url: https://partner.eu.peaka.studio/api/v1
    description: EU Zone
security:
  - bearerAuth: []
paths:
  /connections/config/{connectionType}:
    get:
      tags:
        - Connections
      summary: Get Connection Config
      description: >
        Returns the configuration schema for a specific connection type,
        including required credential fields and their types. Use this to
        understand what parameters are needed when creating a connection of this
        type.
      operationId: getConnectionConfig
      parameters:
        - name: connectionType
          in: path
          description: Type of connection
          required: true
          schema:
            type: string
          example: hubspot
      responses:
        '200':
          description: Connection configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionConfiguration'
components:
  schemas:
    ConnectionConfiguration:
      type: object
      properties:
        connectionType:
          type: string
          description: The type of the connection. e.g. stripe, airtable, etc.
        connectionTypeLabel:
          type: string
          description: The label for the connection type.
        name:
          type: string
          description: The name of the connection.
        authorizationType:
          type: string
          description: >-
            The type of authorization used for the connection. e.g. oauth2,
            api_key, bearer_token, etc.
        credentialSchemaType:
          type: string
          description: The type of the credential schema used for the connection.
        redirectRequired:
          type: boolean
          description: >-
            Flag to indicate if the connection requires redirection to a 3rd
            party platform.

             e.g. OAuth2 connections often require redirection to the 3rd party platform for authorization.

             If this flag is set to true, the connection will be redirected to the 3rd party platform for authorization.

             According to your use case, some extra steps may be required to complete the authorization process.

             See: https://docs.peaka.com/how-to-guides/how-to-create-oauth2-based-connections-via-peaka
        category:
          type: string
          description: The category of the connection.
        configuration:
          type: array
          description: The list of configuration fields for the connection.
          items:
            $ref: '#/components/schemas/ConnectionConfigurationItem'
        documentationUrl:
          type: string
          description: The URL for the documentation of the connection.
    ConnectionConfigurationItem:
      type: object
      properties:
        fieldName:
          type: string
          description: The name of the field.
        fieldType:
          type: string
          description: The type of the field.
          enum:
            - text
            - number
            - boolean
        required:
          type: boolean
          description: Indicates whether the field is required.
        description:
          type: string
          description: The description of the field.
      description: Represents a configuration field for a connection.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Use the Authorization header with the value 'Bearer <apiKey>' to
        authenticate. Partner API Keys have full access; Project API Keys are
        limited to their project scope. Learn more:
        https://docs.peaka.com/api-reference/authentication
      scheme: bearer
      bearerFormat: Api Key

````