custom_objects.record_get

Ver um registro. Um registro do objeto com título, valores por campo e responsável. Registro de outra conta ou inexistente dá not_found.

• Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.record_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: custom_objects_record_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.record_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/custom_objects.record_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

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

MCP: ferramenta custom_objects_record_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"
    },
    "objectId": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "values": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "responsibleAttendantId": {
      "type": [
        "string",
        "null"
      ]
    },
    "responsibleAttendantName": {
      "type": [
        "string",
        "null"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    },
    "relations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "relationId": {
            "type": "string"
          },
          "side": {
            "type": "string",
            "enum": [
              "source",
              "target"
            ]
          },
          "count": {
            "type": "number"
          },
          "preview": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "label"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "relationId",
          "side",
          "count",
          "preview"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "id",
    "objectId",
    "title",
    "values",
    "responsibleAttendantId",
    "responsibleAttendantName",
    "createdAt",
    "updatedAt"
  ],
  "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).