Pular para o conteúdo
Listas de apoio

Listar campos personalizados

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/custom-fields
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)

As fieldKey aceitas em customFields de contatos e negócios (§9.19).

Autorização condicional: entity=contact exige contacts.read; entity=opportunity exige opportunities.read; parâmetro omitido usa entity=contact e exige contacts.read.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • entitystringopcional
    • padrão "contact"
    • um de"contact""opportunity"

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Campos personalizados ATIVOS e de escopo workspace da entidade pedida — as fieldKey que as escritas de customFields aceitam. Campo arquivado ou de escopo de um registro só fica de fora.

  • Cada item — V1CustomField

    • fieldKeystring
    • labelstring
    • typestring
    • requiredboolean
    • optionsstring[] | null