curl --request GET \
--url https://{instance}/wapi/v1/cards \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}/wapi/v1/cards"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}/wapi/v1/cards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}/wapi/v1/cards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}/wapi/v1/cards"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}/wapi/v1/cards")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/wapi/v1/cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"requestId": "req_4a12dc",
"count": 1,
"hasMore": false,
"totalValue": 1500,
"cards": [
{
"id": 981,
"title": "API — Maria Souza",
"value": 1500,
"status": "open",
"probability": 50,
"pipeline": {
"id": 2,
"name": "Vendas"
},
"stage": {
"id": 8,
"name": "Qualificação"
},
"contact": {
"id": 601,
"name": "Maria Souza",
"number": "5534992341048",
"email": null,
"tags": [
{
"id": 3,
"name": "Cliente ativo"
}
]
},
"user": {
"id": 12,
"name": "Ana Paula"
},
"source": {
"id": 4,
"name": "Indicação"
},
"lostReason": null,
"originTicketId": null,
"expectedCloseDate": "2026-10-15",
"closedAt": null,
"stageEnteredAt": "2026-09-20T13:00:00.000Z",
"createdAt": "2026-09-20T13:00:00.000Z",
"updatedAt": "2026-09-20T13:00:00.000Z"
}
]
}{
"error": "ERR_INVALID_DATE_FILTER",
"code": "ERR_INVALID_DATE_FILTER"
}{
"error": "Token não fornecido",
"code": "ERR_TOKEN_MISSING"
}{
"error": "Token sem permissão para esta ação",
"code": "ERR_SCOPE_MISSING"
}{
"error": "Limite de requisições excedido",
"code": "ERR_RATE_LIMITED"
}Listar cards
“Card” é o nome público do funil de pipeline (venda, suporte, cobrança — o pipeline é genérico). Filtre combinando grupos: pipeline/etapa (pipelineId, stageId), contato/tag (contactId, contactTagId — CSV, entra o card cujo contato tem QUALQUER uma das tags; notContactTagId — CSV, exclui pelo mesmo critério, é a forma de achar contatos nunca trabalhados), datas (createdAtAfter/createdAtBefore e closedAtAfter/closedAtBefore, todas ISO-8601 com offset de fuso OBRIGATÓRIO — -03:00 ou Z; sem offset ou apenas-data devolve 400 ERR_INVALID_DATE_FILTER), valor (sortBy=value para ordenar), responsável (userId), status (status=open,won,lost, CSV) e motivo de perda (lostReasonId, cruze com GET /v1/lost-reasons) e origem (sourceId). O id de cada pipeline devolvido em GET /v1/pipelines é o mesmo pipelineId usado aqui e em POST /v1/cards. A paginação usa subquery no banco (necessário porque o card inclui as tags do contato, uma relação 1:N — sem isso a página viria com menos itens ou duplicados). totalValue soma value de TODOS os cards que casam o filtro, não só a página atual. Caso comum — dashboard de marketing “cards criados no mês por etapa e origem”: combine createdAtAfter/createdAtBefore (o mês, com offset) com pipelineId, pagine por stageId e por sourceId (uma chamada por combinação, ou agregue no seu lado ao ler pipeline/stage/source de cada card) e para os perdidos DO PERÍODO use status=lost com closedAtAfter/closedAtBefore (não createdAtAfter/createdAtBefore — esses dois filtram pela criação do card, não por quando ele foi perdido) e cruze lostReasonId com GET /v1/lost-reasons. Requer escopo cards:read.
curl --request GET \
--url https://{instance}/wapi/v1/cards \
--header 'Authorization: Bearer <token>'import requests
url = "https://{instance}/wapi/v1/cards"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{instance}/wapi/v1/cards', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{instance}/wapi/v1/cards",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{instance}/wapi/v1/cards"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{instance}/wapi/v1/cards")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/wapi/v1/cards")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"requestId": "req_4a12dc",
"count": 1,
"hasMore": false,
"totalValue": 1500,
"cards": [
{
"id": 981,
"title": "API — Maria Souza",
"value": 1500,
"status": "open",
"probability": 50,
"pipeline": {
"id": 2,
"name": "Vendas"
},
"stage": {
"id": 8,
"name": "Qualificação"
},
"contact": {
"id": 601,
"name": "Maria Souza",
"number": "5534992341048",
"email": null,
"tags": [
{
"id": 3,
"name": "Cliente ativo"
}
]
},
"user": {
"id": 12,
"name": "Ana Paula"
},
"source": {
"id": 4,
"name": "Indicação"
},
"lostReason": null,
"originTicketId": null,
"expectedCloseDate": "2026-10-15",
"closedAt": null,
"stageEnteredAt": "2026-09-20T13:00:00.000Z",
"createdAt": "2026-09-20T13:00:00.000Z",
"updatedAt": "2026-09-20T13:00:00.000Z"
}
]
}{
"error": "ERR_INVALID_DATE_FILTER",
"code": "ERR_INVALID_DATE_FILTER"
}{
"error": "Token não fornecido",
"code": "ERR_TOKEN_MISSING"
}{
"error": "Token sem permissão para esta ação",
"code": "ERR_SCOPE_MISSING"
}{
"error": "Limite de requisições excedido",
"code": "ERR_RATE_LIMITED"
}Autorizações
Token criado em API → Tokens no painel. Prefixo wtx_live_ (ou wtx_test_).
Parâmetros de consulta
Página (1-based).
Itens por página (máx 100). Exceção: GET .../messages usa default 100 e máx 200.
x <= 100Mesmo id devolvido em GET /v1/pipelines.
CSV de open,won,lost.
"open,won"
Use GET /v1/lost-reasons para descobrir os ids.
Responsável pelo card.
Busca no título do card.
Coluna fora da lista cai silenciosamente pro default (createdAt).
createdAt, closedAt, value, title, stageEnteredAt asc, desc ISO-8601 com offset OBRIGATÓRIO (-03:00 ou Z). Sem offset ou apenas-data devolve 400 ERR_INVALID_DATE_FILTER.
"2026-09-01T00:00:00-03:00"
Mesma exigência de offset de createdAtAfter.
"2026-09-30T23:59:59-03:00"
Mesma exigência de offset de createdAtAfter.
Mesma exigência de offset de createdAtAfter.
IDs de tag (CSV) — inclui cards cujo CONTATO tem QUALQUER uma delas.
"3,7"
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.
"9"