Get Entity Fields

GET

/api/v1/fields/{entity}

API de Produção

Retorna todos os campos disponíveis para uma entidade.

Combina campos nativos (built-in) + campos personalizados do tenant. Usado pelo frontend DataTable para configurar inline editing.

Args: entity: Nome da entidade (contacts, companies, deals, activities) - case insensitive

Authorizations

HTTPBearer

Parameters

Path Parameters

entity

required

Entity

string

Header Parameters

x-tenant-id

Any of:

integer
null

integer

Responses

200

Successful Response

EntityFieldsResponse

Resposta com todos os campos de uma entidade. Combina campos nativos + campos personalizados.

object

entity

required

CustomFieldEntity

Entidades que suportam campos personalizados.

string

Allowed values: contacts companies deals

native_fields

required

Native Fields

Array<object>

FieldConfigResponse

Schema otimizado para frontend DataTable. Retorna apenas o necessário para configurar inline editing.

object

key

required

Key

string

label

required

Label

string

type

required

Type

string

editable

Editable

boolean

default: true

placeholder

Any of:

string
null

string

options

Any of:

Array<object>
null

Array<object>

SelectOption

Opção para campos select/multi_select.

object

value

required

Value

string

label

required

Label

string

color

Any of:

string
null

string

icon

Any of:

string
null

string

validation

Any of:

Array<object>
null

Array<object>

object

asyncLabelField

Any of:

string
null

string

custom_fields

required

Custom Fields

Array<object>

FieldConfigResponse

Schema otimizado para frontend DataTable. Retorna apenas o necessário para configurar inline editing.

object

key

required

Key

string

label

required

Label

string

type

required

Type

string

editable

Editable

boolean

default: true

placeholder

Any of:

string
null

string

options

Any of:

Array<object>
null

Array<object>

SelectOption

Opção para campos select/multi_select.

object

value

required

Value

string

label

required

Label

string

color

Any of:

string
null

string

icon

Any of:

string
null

string

validation

Any of:

Array<object>
null

Array<object>

object

asyncLabelField

Any of:

string
null

string

all_fields

required

All Fields

Array<object>

FieldConfigResponse

Schema otimizado para frontend DataTable. Retorna apenas o necessário para configurar inline editing.

object

key

required

Key

string

label

required

Label

string

type

required

Type

string

editable

Editable

boolean

default: true

placeholder

Any of:

string
null

string

options

Any of:

Array<object>
null

Array<object>

SelectOption

Opção para campos select/multi_select.

object

value

required

Value

string

label

required

Label

string

color

Any of:

string
null

string

icon

Any of:

string
null

string

validation

Any of:

Array<object>
null

Array<object>

object

asyncLabelField

Any of:

string
null

string

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string