List Custom Fields

GET

/api/v1/fields/{entity}/custom

API de Produção

Lista campos personalizados de uma entidade.

Args: entity: Entidade (contacts, companies, deals, activities) - case insensitive include_inactive: Se deve incluir campos desativados

Authorizations

HTTPBearer

Parameters

Path Parameters

entity

required

Entity

string

Query Parameters

include_inactive

Include Inactive

boolean

Header Parameters

x-tenant-id

Any of:

integer
null

integer

Responses

200

Successful Response

CustomFieldListResponse

Schema de resposta para lista de campos.

object

fields

required

Fields

Array<object>

CustomFieldResponse

Schema de resposta para campo personalizado.

object

required

integer

entity

required

CustomFieldEntity

Entidades que suportam campos personalizados.

string

Allowed values: contacts companies deals

key

required

Key

string

label

required

Label

string

description

required

Any of:

string
null

string

field_type

required

CustomFieldType

Tipos de campo suportados.

string

Allowed values: text textarea number decimal currency date datetime boolean select multi_select tags email phone url user

options

required

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

required

Any of:

ValidationConfig
null

ValidationConfig

Configuração de validação.

object

required

Any of:

boolean
null

boolean

min

Any of:

number
null

number

max

Any of:

number
null

number

min_length

Any of:

integer
null

integer

max_length

Any of:

integer
null

integer

pattern

Any of:

string
null

string

pattern_message

Any of:

string
null

string

placeholder

required

Any of:

string
null

string

default_value

required

Any of:

unknown
null

show_in_table

required

Show In Table

boolean

show_in_form

required

Show In Form

boolean

show_in_card

required

Show In Card

boolean

display_order

required

Display Order

integer

is_active

required

Is Active

boolean

is_required

required

Is Required

boolean

is_unique

required

Is Unique

boolean

is_searchable

required

Is Searchable

boolean

is_filterable

required

Is Filterable

boolean

is_sortable

required

Is Sortable

boolean

created_by_id

required

Any of:

integer
null

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

frontend_type

Any of:

string
null

string

total

required

Total

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string