custom_objects.list

Listar objetos personalizados. Objetos personalizados da conta, do mais antigo ao mais novo, com nome no singular e no plural, apiName (não muda se o objeto for renomeado), ícone, cor, gênero da palavra (masculine/feminine), campo-título e as contagens de registros, campos ativos e ligações. Os arquivados só vêm com includeArchived: true. Exige o módulo de plano crm.custom-objects; sem a migration, a lista vem vazia.

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

Entrada

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

Exemplo

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

CLI:

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

MCP: ferramenta custom_objects_list com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "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
      }
    }
  },
  "required": [
    "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).