Skip to Content

Get an integration

Returns one integration with its linked accounts, settings and tools.

GET
/v1/integrations/{integrationId}

Returns one integration with its linked accounts, settings and tools. A Shopify integration needs reconnecting when its account has not granted the requested scopes, including read_products and read_legal_policies.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

integrationId*string
Match^intg_[0-9a-hjkmnp-tv-z]{16,24}$

Response Body

Integration

application/json
  1. response
app*IntegrationKey
Match^[a-z0-9][a-z0-9_-]{0,63}$
settings*
id*IntegrationId
Match^intg_[0-9a-hjkmnp-tv-z]{16,24}$
status*IntegrationStatus
Value in"pending""connected""needsReconnect"
accounts*
supportsContactAccounts*boolean
answerWithoutApproval*AnswerWithoutApproval
tools*array<>
toolPage*
installedBy*|null
createdAt*string
updatedAt*string
Example Request
import { createClient } from "samva";

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

const result = await samva.integrations.get({
  "integrationId": "example"
});
Example Response
{
  "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"
}

Related documentation