Skip to main content
POST

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir o JWT da conta no header Authorization no formato Bearer. Sem esse header a requisição é recusada.

Body

application/json
query
string
required

Texto da busca.

Example:

"projeto alfa"

paginationType
string
required

Use cursor.

Example:

"cursor"

companyId
string
required

Empresa da sessão.

Example:

"UUID_DA_EMPRESA"

userId
string
required

Usuário da sessão.

Example:

"UUID_DO_USUARIO"

entityTypes
string[]

Lead, CrmContact, CrmOrganization, CrmActivity, CrmProduct, CrmReservation, called, HelpDeskTicket, Client, Project, CompanyProduct, ResponseCalled, Files, Meeting.

Example:
limit
integer

De 1 a 100.

Example:

1

cursor
string

Página seguinte, quando a resposta trouxer cursor.

Example:

"exemplo"

Response

A operação concluiu. success é true, code é SUCCESS e o conteúdo vem em data.

success
boolean
required
Example:

true

data
any
required

Conteúdo da operação. O exemplo 200 de cada rota preenche os campos do recurso.

code
string
required
Example:

"SUCCESS"