Pular para o conteúdo principal
GET
List items

Autorizações

Authorization
string
header
obrigatório

An API key created by the chain owner in the panel (Integrações → Nova chave), sent as Authorization: Bearer <key>. The key (<id>|na_…) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.

Cabeçalhos

Accept-Language
enum<string>

Language of message and of translated content such as item names (pt-BR or en). Without it, the chain's default language.

Opções disponíveis:
pt-BR,
en
X-Request-Id
string

Your own correlation id (1–64 characters of A-Za-z0-9._-), echoed back; generated when absent. Quote it to support.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Parâmetros de caminho

establishment
integer
obrigatório

The establishment ID

Parâmetros de consulta

status
enum<string>
Opções disponíveis:
active,
paused,
archived
queue_type
enum<string>
Opções disponíveis:
single,
recurring
search
string | null
Maximum string length: 100
external_reference
string | null
Maximum string length: 100
sort
enum<string>
Opções disponíveis:
name,
created_at,
subscribers_count
direction
enum<string>
Opções disponíveis:
asc,
desc
per_page
integer
Intervalo obrigatório: 1 <= x <= 100
page
integer
padrão:1

Page number.

Resposta

Paginated set of Item

data
Item · object[]
obrigatório
meta
object
obrigatório