Create View

POST

/api/v1/views/{entity}

• API de Produção

Cria uma nova view.

Views do sistema (scope=system) nao podem ser criadas via API.

Authorizations

• HTTPBearer

Parameters

Path Parameters

entity

required

Entity

string

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Request Body ^required

SavedViewCreate

Schema para criar uma view.

object

name

required

Name

string

>= 1 characters <= 100 characters

description

Any of:

string

string

<= 500 characters

null

null

icon

Icon

string

default: filter <= 50 characters

color

Color

string

default: blue <= 20 characters

entity

required

ViewEntityEnum

Entidade alvo da view.

string

Allowed values: contacts companies deals activities conversations

scope

string

Allowed values: private team system

filters

Any of:

FilterConfig

FilterConfig

Configuracao completa de filtros.

object

conditions

Conditions

Array<object>

FilterCondition

Condicao individual de filtro.

object

field

required

Field

Nome do campo a filtrar

string

operator

required

Operator

Operador de comparacao

string

value

Value

Valor para comparacao

Example

{
  "field": "status",
  "operator": "equals",
  "value": "active"
}

logic

Logic

‘and’ ou ‘or’

string

default: and

Example

{
  "conditions": [
    {
      "field": "status",
      "operator": "equals",
      "value": "active"
    },
    {
      "field": "created_at",
      "operator": "after",
      "value": "2024-01-01"
    }
  ],
  "logic": "and"
}

null

null

sorting

Sorting

Array<object>

SortConfig

Configuracao de ordenacao.

object

field

required

Field

Nome do campo

string

direction

Direction

‘asc’ ou ‘desc’

string

default: asc

columns

Columns

Array<string>

column_widths

Column Widths

object

key

additional properties

integer

grouping

Any of:

GroupConfig

GroupConfig

Configuracao de agrupamento.

object

field

required

Field

Campo para agrupar

string

collapsed_groups

Collapsed Groups

Grupos colapsados

Array<string>

null

null

is_default

Is Default

boolean

is_pinned

Is Pinned

boolean

Responses

201

Successful Response

SavedViewResponse

Schema de resposta para uma view.

object

id

required

Id

integer

name

required

Name

string

description

Any of:

string

string

null

null

icon

required

Icon

string

color

required

Color

string

entity

required

ViewEntityEnum

Entidade alvo da view.

string

Allowed values: contacts companies deals activities conversations

scope

required

ViewScopeEnum

Escopo de visibilidade.

string

Allowed values: private team system

filters

Any of:

object

object

null

null

sorting

Sorting

Array<object>

object

columns

Columns

Array<string>

column_widths

Column Widths

object

key

additional properties

integer

grouping

Any of:

object

object

null

null

is_default

required

Is Default

boolean

is_pinned

required

Is Pinned

boolean

usage_count

required

Usage Count

integer

created_by_id

required

Created By Id

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

last_used_at

Any of:

string

string format: date-time

null

null

is_owner

Is Owner

boolean

can_edit

Can Edit

boolean

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string