Skip to main content
GET
Listar SMS

Autorizações

Authorization
string
header
obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Parâmetros de consulta

page
string

Página (padrão 1).

limit
string

Itens por página (padrão 20, máx. 100).

fromDate
string<date-time>

Início do intervalo (filtro em createdAt, inclusive).

toDate
string<date-time>

Fim do intervalo (filtro em createdAt, inclusive).

status
string

Um ou mais status separados por vírgula: QUEUED, SCHEDULED, SENT, PROCESSING, DELIVERED, FAILED, CANCELLED. Valores inválidos são ignorados.

Resposta

Lista de SMS e paginação.

success
boolean
obrigatório
Exemplo:

true

data
object[]
obrigatório

Cada item tem os mesmos campos que GET /v1/sms/messages/{id} em data (sem campos extras).

pagination
object
obrigatório