Recupera os registros pertencentes a uma audiência previamente gerada, identificada por um list_id
.
Os resultados são retornados de forma paginada.
Para receber o list_id, favor solicitar via abertura de chamado.
GET https://segments-xp.wake.tech/v1/lists/{list_id}
Requer um token Bearer válido. (Ver seção Optin / Gerar Token )
Nome Tipo Localização Obrigatório Descrição list_id
string path ✅ ID único da audiência cadastrada para exportação. limit
integer query ❌ Quantidade de itens por página. Padrão: 10
. Mínimo: 10
, Máximo: 100
. page
integer query ❌ Número da página a ser retornada. Padrão: 1
. Mínimo: 1
.
HTTP
GET /v1/lists/abc123?limit=20&page=1 HTTP/1.1
Host: https://segments-xp.wake.tech
Authorization: Bearer seu_token_aqui
JSON
{
"total": 2,
"page": 1,
"total_pages": 1,
"success": true,
"limit": 10,
"last_updated": "2025-04-30T14:23:00Z",
"result": [
{
"id": "1a2b3c",
"name": "Maria Silva",
"email": "[email protected] ",
"created_at": "2024-12-10T08:00:00Z"
},
{
"id": "4d5e6f",
"name": "João Oliveira",
"email": "[email protected] ",
"created_at": "2024-12-12T10:15:30Z"
},
]
}
Campo Tipo Descrição total
integer Total de registros encontrados. page
integer Página atual. total_pages
integer Número total de páginas. success
boolean Indica se a operação foi bem-sucedida. limit
integer Quantidade de registros por página. last_updated
string Data/hora da última atualização da lista. result
array Lista dos registros exportáveis.
Código Descrição 200
Requisição bem-sucedida 401
Não autorizado 404
Audiência não encontrada 422
Erro de validação
JSON
{
"detail": [
{
"loc": ["string", 0],
"msg": "string",
"type": "string"
}
]
}
Campo Tipo Descrição loc
array Local do parâmetro inválido. msg
string Mensagem descritiva do erro. type
string Tipo do erro de validação.