GET
/
connections
/
config
/
{connectionType}
curl --request GET \
  --url https://partner.peaka.studio/api/v1/connections/config/{connectionType} \
  --header 'Authorization: Bearer <token>'
{
  "connectionType": "<string>",
  "connectionTypeLabel": "<string>",
  "name": "<string>",
  "authorizationType": "<string>",
  "credentialSchemaType": "<string>",
  "redirectRequired": true,
  "category": "<string>",
  "configuration": [
    {
      "fieldName": "<string>",
      "fieldType": "text",
      "required": true,
      "description": "<string>"
    }
  ],
  "documentationUrl": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
connectionType
string
required

Type of connection

Response

200 - */*
OK
​
connectionType
string

The type of the connection. e.g. stripe, airtable, etc.

​
connectionTypeLabel
string

The label for the connection type.

​
name
string

The name of the connection.

​
authorizationType
string

The type of authorization used for the connection. e.g. oauth2, api_key, bearer_token, etc.

​
credentialSchemaType
string

The type of the credential schema used for the connection.

​
redirectRequired
boolean

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
string

The category of the connection.

​
configuration
object[]

The list of configuration fields for the connection.

Represents a configuration field for a connection.

​
documentationUrl
string

The URL for the documentation of the connection.