Connections
List Connections
This HTTP GET request retrieves connections for a specific project by project ID. The response will include an array of connection objects, each containing details such as ID, name, connection type, authorization type, provider, credential schema type, configuration, and group code.
The response will consist of a status code 200, and an array of connection objects. Each connection object will include the following properties:
- “id”: The unique identifier for the connection.
- “name”: The name of the connection.
- “connectionType”: The type of connection.
- “authorizationType”: The type of authorization used.
- “provider”: The provider of the connection.
- “credentialSchemaType”: The type of credential schema used.
- “configuration”: An array of objects containing configuration details such as name, label, type, required status, advanced status, visibility, description, and nested properties.
- “groupCode”: The group code associated with the connection.
Here are some examples of the response objects:
- Connection with Stripe: - ID: c6883de8-78ab-49fb-93c0-70a13652a341 - Name: Stripe Code2 - Connection Type: stripe - Authorization Type: bearer_token - Provider: stripe - Credential Schema Type: bearer_token_credential_schema - Configuration: - Name: token - Label: API Key - Type: password - Required: true - Advanced: false - Visible: true - Description: Api Key - Group Code: stripe
- Connection with Airtable: - ID: 81e6dfd0-4c88-4e81-a28b-422e89cc07c7 - Name: airtable - Connection Type: airtable - Authorization Type: bearer_token - Provider: airtable - Credential Schema Type: airtable_custom_credential_schema - Configuration: - Name: personalAccessToken - Label: Personal Access Token - Type: password - Required: true - Advanced: false - Visible: true - Description: Personal Access Token - Group Code: airtable (Additional examples provided in the response data)
GET
/
connections
/
{projectId}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
projectId
string
requiredResponse
200 - application/json
The response is of type object
.