AtomiksAPI
Ver .md

custom_objects.access_list

Cargos e permissões de objetos. A aba Acesso: quem mexe nos registros. O Atomiks não tem grupos de permissão, então os "cargos" são os papéis do membro: admin (ver, criar, editar, excluir e configurar, em todos os registros) e user (ver, criar, editar e excluir todos os registros, sem configurar objetos, campos e ligações). Cada cargo traz members (ids dos membros) e permissions (custom-objects:<ação>:all). A permissão vale para todos os objetos juntos.

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

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.access_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

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

MCP: ferramenta custom_objects_access_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"
          },
          "name": {
            "type": "string"
          },
          "members": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "permissions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "name",
          "members",
          "permissions"
        ],
        "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).