Skip to main content
GET
/
v1
/
integrations
/
{integrationId}
Get Integration
curl --request GET \
  --url https://api.sigmamind.ai/v1/integrations/{integrationId} \
  --header 'X-API-Key: <api-key>'
{
  "integrationId": "intg_AuUKK371Spr5",
  "name": "My Shopify Store",
  "description": "Handles order lookups and customer data retrieval",
  "authentication": {
    "authId": "auth_P3kNz7Yv1Qm9",
    "integrationId": "intg_AuUKK371Spr5",
    "authType": "API_KEY",
    "headers": [
      {
        "key": "X-Request-Source",
        "value": "sigmamind"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "tools": [
    {
      "toolId": "tool_X9pLm2Wq8Rt3",
      "integrationId": "intg_AuUKK371Spr5",
      "name": "get_order_details",
      "description": "Fetches order details from Shopify by order ID. Call this tool when you need to retrieve order status, line items, or shipping info.",
      "method": "GET",
      "url": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
      "scope": "local",
      "headers": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "queryParams": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "bodyParams": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "createdAt": "2024-04-20T10:00:00.000Z",
      "updatedAt": "2024-04-21T08:30:00.000Z"
    }
  ],
  "createdAt": "2024-04-20T10:00:00.000Z",
  "updatedAt": "2024-04-21T08:30:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

​
integrationId
string
required

Unique identifier of the integration to retrieve.

Response

OK

Represents a fully configured third-party integration. Includes its identity, authentication configuration, and available tools. Use this response to understand how to invoke external APIs via this integration. Authentication and headers are automatically applied when tools under this integration are executed.

​
integrationId
string

Unique identifier for this integration. Pass this value as integrationId when executing tools, updating this integration, or managing its auth configuration.

Example:

"intg_AuUKK371Spr5"

​
name
string

Human-readable name of the integration. Helps identify the connected system (e.g., Shopify store, CRM, payment provider).

Example:

"My Shopify Store"

​
description
string

Optional explanation of what this integration is used for. Useful for agents to determine when this integration should be selected.

Example:

"Handles order lookups and customer data retrieval"

​
authentication
object
​
tools
object[]

Catalog of executable operations available via this integration. Each tool represents a specific API capability (e.g., fetch order, create customer). To perform an action: inspect each tool's name and description, select the one matching the task, then invoke it using its toolId. An empty list means no tools have been configured yet.

​
createdAt
string<date-time>

Timestamp when the integration was created (in UTC). Primarily for auditing and tracking purposes.

Example:

"2024-04-20T10:00:00.000Z"

​
updatedAt
string<date-time>

Timestamp when the integration was last updated (in UTC). Indicates the most recent configuration change.

Example:

"2024-04-21T08:30:00.000Z"