Ver .md

contacts.export_get

Ver uma exportação e baixar o CSV. Status (queued, running, done, failed), contatos no arquivo e, quando pronta, url assinada para baixar (vale 5 minutos; chame de novo para outra). O arquivo fica guardado por 24 horas; depois url volta null com expired: true. Quem pediu vê a sua; admin vê todas da conta.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/contacts.export_get (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: contacts:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: contacts_export_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId contacts.export_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.export_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.export_get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta contacts_export_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"
    },
    "status": {
      "type": "string",
      "enum": [
        "queued",
        "running",
        "done",
        "failed"
      ]
    },
    "url": {
      "type": [
        "string",
        "null"
      ]
    },
    "count": {
      "type": "number"
    },
    "processed": {
      "type": "number"
    },
    "expired": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "finishedAt": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "status",
    "url",
    "count",
    "processed",
    "expired",
    "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).