Skip to main content
GET
Listar cards

Authorizations

Authorization
string
header
required

Token criado em API → Tokens no painel. Prefixo wtx_live_ (ou wtx_test_).

Query Parameters

pageNumber
integer
default:1

Página (1-based).

pageSize
integer
default:40

Itens por página (máx 100). Exceção: GET .../messages usa default 100 e máx 200.

Required range: x <= 100
pipelineId
integer

Mesmo id devolvido em GET /v1/pipelines.

stageId
integer
status
string

CSV de open,won,lost.

Example:

"open,won"

lostReasonId
integer

Use GET /v1/lost-reasons para descobrir os ids.

userId
integer

Responsável pelo card.

contactId
integer
sourceId
integer
searchParam
string

Busca no título do card.

sortBy
enum<string>
default:createdAt

Coluna fora da lista cai silenciosamente pro default (createdAt).

Available options:
createdAt,
closedAt,
value,
title,
stageEnteredAt
sortDir
enum<string>
default:desc
Available options:
asc,
desc
createdAtAfter
string<date-time>

ISO-8601 com offset OBRIGATÓRIO (-03:00 ou Z). Sem offset ou apenas-data devolve 400 ERR_INVALID_DATE_FILTER.

Example:

"2026-09-01T00:00:00-03:00"

createdAtBefore
string<date-time>

Mesma exigência de offset de createdAtAfter.

Example:

"2026-09-30T23:59:59-03:00"

closedAtAfter
string<date-time>

Mesma exigência de offset de createdAtAfter.

closedAtBefore
string<date-time>

Mesma exigência de offset de createdAtAfter.

contactTagId
string

IDs de tag (CSV) — inclui cards cujo CONTATO tem QUALQUER uma delas.

Example:

"3,7"

notContactTagId
string

IDs de tag (CSV) — exclui cards cujo CONTATO tem QUALQUER uma delas. Use pra achar contatos nunca trabalhados: filtre sem esse id de tag e crie a tag no contato assim que um card é aberto.

Example:

"9"

Response

Página de cards.

requestId
string
count
integer
hasMore
boolean
totalValue
number

Soma de value de TODOS os cards que casam o filtro (não só a página).

cards
object[]