AtomiksAPI
Ver .md

custom_objects.overview

Visão geral dos objetos e ligações. Tudo da tela Objetos de uma vez: objects (arquivados inclusive, com archivedAt), relations (ligações dos objetos, com linkCount) e system (Contatos, Oportunidades e Empresas com recordCount e customFieldCount; Oportunidades e Empresas não têm campos personalizados no Atomiks).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.overview (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_overview
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.overview)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.overview \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs custom_objects.overview --json '{}'

MCP: ferramenta custom_objects_overview com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "objects": {
      "type": "array",
      "items": {
        "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
      }
    },
    "relations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "objectId": {
            "type": "string"
          },
          "sourceObject": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "singularName": {
                "type": "string"
              },
              "pluralName": {
                "type": "string"
              },
              "icon": {
                "type": "string"
              },
              "color": {
                "type": "string"
              },
              "gender": {
                "type": "string",
                "enum": [
                  "masculine",
                  "feminine"
                ]
              }
            },
            "required": [
              "id",
              "singularName",
              "pluralName",
              "icon",
              "color",
              "gender"
            ],
            "additionalProperties": false
          },
          "sourceLabel": {
            "type": "string"
          },
          "targetLabel": {
            "type": "string"
          },
          "targetType": {
            "type": "string",
            "enum": [
              "leads",
              "opportunities",
              "companies",
              "objects"
            ]
          },
          "targetObjectId": {
            "type": [
              "string",
              "null"
            ]
          },
          "targetObject": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string"
                  },
                  "singularName": {
                    "type": "string"
                  },
                  "pluralName": {
                    "type": "string"
                  },
                  "icon": {
                    "type": "string"
                  },
                  "color": {
                    "type": "string"
                  },
                  "gender": {
                    "type": "string",
                    "enum": [
                      "masculine",
                      "feminine"
                    ]
                  }
                },
                "required": [
                  "id",
                  "singularName",
                  "pluralName",
                  "icon",
                  "color",
                  "gender"
                ],
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "cardinality": {
            "type": "string",
            "enum": [
              "many_to_one",
              "one_to_many",
              "many_to_many"
            ]
          },
          "showOnCard": {
            "type": "boolean"
          },
          "linkCount": {
            "type": "number"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "objectId",
          "sourceObject",
          "sourceLabel",
          "targetLabel",
          "targetType",
          "targetObjectId",
          "targetObject",
          "cardinality",
          "showOnCard",
          "linkCount",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    },
    "system": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "leads",
              "opportunities",
              "companies"
            ]
          },
          "recordCount": {
            "type": "number"
          },
          "customFieldCount": {
            "type": "number"
          }
        },
        "required": [
          "type",
          "recordCount",
          "customFieldCount"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "objects",
    "relations",
    "system"
  ],
  "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).