integrations.get

Ver uma integração. Dados da integração, URL de entrada (nula nas de saída) e configuração. O segredo nunca é devolvido.

• Endpoint: POST https://app.atomiks.com.br/api/v1/integrations.get (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: automations:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: integrations_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId integrations.get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/integrations.get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs integrations.get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta integrations_get com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "connector": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "paused"
      ]
    },
    "secretHint": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastEventAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "counts": {
      "type": "object",
      "properties": {
        "events24h": {
          "type": "number"
        },
        "failed24h": {
          "type": "number"
        },
        "total": {
          "type": "number"
        }
      },
      "required": [
        "events24h",
        "failed24h"
      ],
      "additionalProperties": false
    },
    "url": {
      "type": [
        "string",
        "null"
      ]
    },
    "triggers": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "inboundUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "config": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    }
  },
  "required": [
    "id",
    "connector",
    "name",
    "status",
    "secretHint",
    "lastEventAt",
    "createdAt",
    "counts",
    "inboundUrl",
    "config"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).