Skip to Content

List integrations

Returns a bounded page of installed integrations, newest first, with compact tool summaries.

GET
/v1/integrations

Returns a bounded page of installed integrations, newest first, with compact tool summaries. Follow nextCursor and each integration's toolPage.nextOffset for the complete inventory.

Authorization

apiKey
headerx-api-key<token>

Query Parameters

limit?|null
cursor?string

Response Body

IntegrationList

application/json
  1. response
items*array<>
nextCursor*string|null
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.integrations.list({});
Example Response
{
  "items": [
    {
      "app": "string",
      "settings": {
        "property1": "string",
        "property2": "string"
      },
      "id": "string",
      "status": "pending",
      "accounts": {
        "property1": "string",
        "property2": "string"
      },
      "supportsContactAccounts": true,
      "answerWithoutApproval": true,
      "tools": [
        {
          "name": "string",
          "title": "string",
          "kind": "query",
          "effect": "read",
          "guards": [
            "pinnedDestination"
          ],
          "granted": true,
          "unavailableReason": "input_schema_too_large",
          "enabled": true,
          "runsWithoutApproval": true
        }
      ],
      "toolPage": {
        "nextOffset": 0,
        "total": 0,
        "revision": "string"
      },
      "installedBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "nextCursor": "string"
}

Related documentation