List Connections

Retrieves all connections for the specified Project. A Connection represents an authenticated link to an external data source (e.g., Stripe, Airtable, PostgreSQL).

GET /connections/{projectId}

List Connections

cURL

curl --request GET \
  --url https://partner.peaka.studio/api/v1/connections/{projectId} \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "c6883de8-78ab-49fb-93c0-70a13652a341",
    "name": "Stripe Code2",
    "type": "stripe"
  },
  {
    "id": "81e6dfd0-4c88-4e81-a28b-422e89cc07c7",
    "name": "airtable",
    "type": "airtable"
  },
  {
    "id": "8db17e23-29de-4dab-8886-af9717e0e742",
    "name": "airtable2",
    "type": "airtable"
  },
  {
    "id": "22706960-023c-411e-a3ac-62d286fa6685",
    "name": "exampleAirtableConnection",
    "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

Response

200 - application/json

List of Connections

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.