Listar custom fields

GET/api/v1/custom-fields

Lista custom fields do workspace. Use a key de cada um como chave do objeto customFields ao criar/atualizar deals, contatos e empresas; type diz o formato do valor e options vem preenchido quando o tipo é SELECT/MULTISELECT.

Parâmetros de query

entity

enum

Filtra por entidade dona do campo.

DEALACCOUNTCONTACT

Sem paginação · volume baixo.

Tipos de campo aceitos pela API: TEXT, URL, EMAIL, PHONE (string) · NUMBER (number) · BOOLEAN (boolean) · DATE (string ISO) · SELECT (string de options) · MULTISELECT (array de strings de options).

Valor fora das options de SELECT/MULTISELECT retorna 422 com a lista de opções aceitas em details.allowedOptions.

Autenticação: header Authorization: Bearer rmk_... · veja Introdução e autenticação.

curl "https://crmdojordao.com.br/api/v1/custom-fields" \
  -H "Authorization: Bearer rmk_SUA_CHAVE"

Resposta · GET /api/v1/custom-fields

{
  "data": [
    {
      "id": "cf_fonte_lead",
      "key": "fonte_lead",
      "label": "Fonte do lead",
      "type": "SELECT",
      "entity": "DEAL",
      "required": false,
      "options": ["Indicação", "Inbound", "Outbound", "Evento", "LinkedIn"]
    }
  ]
}