Skip to main content
GET
Buscar cards do painel

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de caminho

boardId
integer
obrigatório

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100

Busca no nome e na descrição do card, sem diferenciar maiúsculas de minúsculas.

crmBoardListId
integer

Só os cards desta etapa do painel.

assignedToUserId
integer

Só os cards sob a responsabilidade deste usuário.

crmOriginId
integer

Só os cards desta origem.

crmBusinessId
integer

Só os cards vinculados a este negócio.

crmBoardCardStatusId
integer

Só os cards com este status. Os status são configurados em cada etapa.

contactId
integer

Só os cards vinculados a este contato.

won
boolean

true traz só os cards ganhos e false, só os não ganhos. Sem o parâmetro, vêm os dois.

creationSource
enum<string>

Filtra pelo meio usado para criar o card. Quem criou o registro:

Opções disponíveis:
api,
user,
bot,
automation
createdFrom
string<date-time>

Só os cards criados a partir desta data. O dia começa no fuso da sua empresa.

createdTo
string<date-time>

Só os cards criados até esta data. O dia termina às 23:59:59 no fuso da sua empresa.

dueFrom
string<date-time>

Só os cards com prazo a partir desta data. O dia começa no fuso da sua empresa.

dueTo
string<date-time>

Só os cards com prazo até esta data. O dia termina às 23:59:59 no fuso da sua empresa.

orderBy
enum<string>
padrão:createdAt

Campo usado para ordenar a lista. Um valor desconhecido é trocado pelo padrão. Campo usado para ordenar:

Opções disponíveis:
createdAt,
updatedAt,
due,
position,
name
order
enum<string>
padrão:desc

Direção da ordenação: asc crescente, desc decrescente. Direção da ordenação:

Opções disponíveis:
asc,
desc

Resposta

OK

data
object[]
meta
object
Exemplo: