Pular para o conteúdo
Healthing CRM

List Views

GET
/api/v1/views/{entity}

Lista todas as views disponiveis para uma entidade.

Inclui views proprias, do time e do sistema. Ordenadas por: fixadas > padrao > mais usadas > nome.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
entity
required
Entity
string

Query Parameters

Seção intitulada “Query Parameters ”
include_system
Include System

Incluir views do sistema

boolean
default: true

Incluir views do sistema

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

SavedViewListResponse

Lista de views com metadata.

object
views
required
Views
Array<object>
SavedViewResponse

Schema de resposta para uma view.

object
id
required
Id
integer
name
required
Name
string
description
Any of:
string
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
sorting
Sorting
Array<object>
object
columns
Columns
Array<string>
column_widths
Column Widths
object
key
additional properties
integer
grouping
Any of:
object
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 format: date-time
is_owner
Is Owner
boolean
can_edit
Can Edit
boolean
total
required
Total
integer
pinned_count
required
Pinned Count
integer
system_count
required
System Count
integer

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string