Ver .md

contacts.import_get

Ver o andamento de uma importação. Status (queued, running, done, failed), linhas totais e processadas, contatos criados, atualizados e com falha, e até 100 falhas por linha (row = linha do arquivo, contando o cabeçalho como 1). Quem importou vê a sua; admin vê todas da conta.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
JSON Schema
{
  "$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/contacts.import_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

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

MCP: ferramenta contacts_import_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"
    },
    "fileName": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "done",
        "failed"
      ]
    },
    "total": {
      "type": "number"
    },
    "processed": {
      "type": "number"
    },
    "created": {
      "type": "number"
    },
    "updated": {
      "type": "number"
    },
    "failed": {
      "type": "number"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "row": {
            "type": "number"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "row",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "finishedAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "fileName",
    "status",
    "total",
    "processed",
    "created",
    "updated",
    "failed",
    "errors",
    "error",
    "createdAt",
    "finishedAt"
  ],
  "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).