List connections

List all connections for the user.

GET /connections/list

JavaScript

JavaScript

import Hyperspell from '@hyperspell/hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

const connections = await client.connections.list();

console.log(connections.connections);

200

{
  "connections": [
    {
      "id": "<string>",
      "integration_id": "<string>",
      "label": "<string>",
      "selected_count": 0
    }
  ]
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Response

200 - application/json

Successful Response

connections · ConnectionInfo · object[] · required

Show child attributes