Ver .md

groups.job_get

Ver um job de grupos. O job com os 200 primeiros itens (posição, estado, erro e nome do grupo quando há).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/groups.job_get (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: marketing:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: groups_job_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId groups.job_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/groups.job_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-4000-8000-000000000001"}'

CLI:

node cli/atomiks.mjs groups.job_get --json '{"id":"00000000-0000-4000-8000-000000000001"}'

MCP: ferramenta groups_job_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"
    },
    "kind": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "done": {
      "type": "number"
    },
    "failed": {
      "type": "number"
    },
    "nextAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "lastReason": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "position": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "position",
          "status",
          "error",
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "kind",
    "status",
    "total",
    "done",
    "failed",
    "nextAt",
    "lastReason",
    "createdAt",
    "items"
  ],
  "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).