Sign in
latestOpenAPI 3.0.12026-08-1914141.6 MB

c656412a58bc

Campos personalizados

Listar campos

Lista os campos de um determinado campo personalizado.

get/entities/{entity_id}/fields

Path parameters

entity_idinteger required

ID do campo personalizado

Query parameters

offsetinteger

Número da página a ser retornada

limitinteger

Número de itens retornados na página

requiredboolean

Filtra por campos obrigatórios ou não obrigatórios

field_type'text' | 'text_area' | 'currency' | 'phone' | 'email' | 'link' | 'date' | 'single_select' | 'checkbox'

Filtra pelo tipo do campo

namestring

Busca os campos pelo nome

Response

idinteger required

Identificador do campo

field_type'email' | 'date' | 'currency' | 'phone' | 'checkbox' | 'text' | 'text_area' | 'single_select' | 'link' required

Tipos de campo: "email", "date", "currency", "phone", "checkbox", "text", "text_area", "single_select", "link"

indexinteger required

Ordem na qual os campos são exibidos na interface do tiflux

namestring required

Nome do campo personalizado

requiredboolean required

Informa se o campo personalizado é de preenchimento obrigatório