Skip to main content
GET
/
connections
/
{projectId}
/
{connectionId}
Get Connection
curl --request GET \
  --url https://partner.peaka.studio/api/v1/connections/{projectId}/{connectionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "8db17e23-29de-4dab-8886-af9717e0e742",
  "name": "airtable2",
  "type": "airtable"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' 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

Path Parameters

​
projectId
string
required

ID of the project

​
connectionId
string
required

ID of the connection

Response

200 - application/json

Get Connection by ID

​
id
string

Connection ID

​
name
string

Name of the connection

​
type
string

Type of connection.

Example: airtable for AirTable, stripe for Stripe, hubspot_access_token for HubSpot (with Access Token), etc.

Exact list can be fetched by following url: /connections/config

​
url
string

Oauth callback url if the connection is Oauth based.