# custom_objects.relation_filter_fields

Campos filtráveis do outro lado de uma ligação. Campos que o filtro por ligação aceita nas pontas: `side` é o lado em que estão os registros do objeto (`source` = a ponta é o alvo da ligação; `target` = a ponta é o objeto dono). Devolve `type` e `objectId` da ponta e `fields` (`key` para o `fieldId` de `conditions`, `label`, `group` fields|dates, `type` text|number|date|boolean|enum, `multi` e `enumOptions`). Contato: nome, telefone, e-mail, criação e campos personalizados; oportunidade: título, situação, valor e criação; objeto: título, campos filtráveis e datas; empresa não tem campos (só ter ou não vínculo).

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

## Entrada

| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
| `relationId` | string (uuid) | sim |  |
| `side` | "source" \| "target" | sim |  |

<details><summary>JSON Schema</summary>

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "relationId": {
      "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)$"
    },
    "side": {
      "type": "string",
      "enum": [
        "source",
        "target"
      ]
    }
  },
  "required": [
    "relationId",
    "side"
  ]
}
```

</details>

## Exemplo

```bash
curl -X POST https://app.atomiks.com.br/api/v1/custom_objects.relation_filter_fields \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"relationId":"00000000-0000-0000-0000-000000000000","side":"source"}'
```

CLI:

```bash
node cli/atomiks.mjs custom_objects.relation_filter_fields --json '{"relationId":"00000000-0000-0000-0000-000000000000","side":"source"}'
```

MCP: ferramenta `custom_objects_relation_filter_fields` com a mesma entrada.

## Saída

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

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "leads",
        "opportunities",
        "companies",
        "objects"
      ]
    },
    "objectId": {
      "type": [
        "string",
        "null"
      ]
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "group": {
            "type": "string",
            "enum": [
              "fields",
              "dates"
            ]
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "number",
              "date",
              "boolean",
              "enum"
            ]
          },
          "multi": {
            "type": "boolean"
          },
          "enumOptions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "value": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                }
              },
              "required": [
                "value",
                "label"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "key",
          "label",
          "group",
          "type"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "type",
    "objectId",
    "fields"
  ],
  "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).