custom_objects.get

Ver um objeto. Um objeto com o campo-título (titleField) e as contagens de registros, campos ativos e ligações. Objeto de outra conta ou inexistente dá not_found.

• Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.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_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.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.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.get --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta custom_objects_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"
    },
    "singularName": {
      "type": "string"
    },
    "pluralName": {
      "type": "string"
    },
    "icon": {
      "type": "string"
    },
    "color": {
      "type": "string"
    },
    "gender": {
      "type": "string",
      "enum": [
        "masculine",
        "feminine"
      ]
    },
    "apiName": {
      "type": "string"
    },
    "archivedAt": {
      "type": [
        "string",
        "null"
      ]
    },
    "titleFieldId": {
      "type": [
        "string",
        "null"
      ]
    },
    "titleField": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "displayName": {
              "type": "string"
            }
          },
          "required": [
            "id",
            "displayName"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "recordCount": {
      "type": "number"
    },
    "fieldCount": {
      "type": "number"
    },
    "relationCount": {
      "type": "number"
    },
    "createdAt": {
      "type": "string"
    },
    "updatedAt": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "singularName",
    "pluralName",
    "icon",
    "color",
    "gender",
    "apiName",
    "archivedAt",
    "titleFieldId",
    "titleField",
    "recordCount",
    "fieldCount",
    "relationCount",
    "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).