Pular para o conteúdo principal
GET
Listar jornadas

Exemplo

Autorizações

Authorization
string
header
obrigatório

JWT da plataforma ou API key mtk_live_...

Parâmetros de consulta

container_id
string

Container a consultar (ObjectId, domínio ou MTC-XXXX). Dispensável com chave de API do container; obrigatório com chave do workspace.

Exemplo:

"MTC-AB12"

phone
string

Telefone do lead. Aceita qualquer formatação; número brasileiro sem DDI ganha o 55.

Exemplo:

"5511999998888"

email
string

E-mail exato do lead.

Exemplo:

"cliente@email.com"

document
string

CPF ou CNPJ, com ou sem pontuação.

Exemplo:

"123.456.789-00"

created_after
string<date-time>

Só leads criados a partir desta data (ISO 8601).

Exemplo:

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

created_before
string<date-time>

Só leads criados até esta data (ISO 8601).

identified_only
boolean
padrão:true

true (padrão) devolve só leads com nome, e-mail, telefone ou documento. false inclui visitantes anônimos.

include_bots
boolean
padrão:false

Inclui leads marcados como bot.

order
enum<string>
padrão:desc

Ordem pela data de criação.

Opções disponíveis:
desc,
asc
page
integer
padrão:1
Intervalo obrigatório: x >= 1
limit
integer
padrão:20

Jornadas por página (1 a 50).

Intervalo obrigatório: 1 <= x <= 50
events_limit
integer
padrão:200

Máximo de eventos por jornada, a partir do primeiro (1 a 500).

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

Resposta

Página de jornadas

object
string
Allowed value: "list"
data
object[]
page
integer
limit
integer
has_more
boolean