Paginação
Os endpoints de listagem (GET /emails, /domains, /api-keys, /webhooks, /audiences, /audiences/{id}/contacts, /broadcasts, /suppressions) compartilham um único esquema baseado em cursor.
| Parâmetro | Descrição |
|---|---|
limit |
Itens por página, de 1 a 100. Padrão 20. |
after |
O id de um item. Retorna a página de itens mais antigos que ele (a próxima página). |
before |
O id de um item. Retorna a página de itens mais novos que ele (a página anterior). |
Use apenas um entre after e before; os dois juntos retornam 422. Os resultados vêm do mais novo para o mais antigo. Os cursores são ids de itens (UUIDv7, que se ordenam por data de criação), então as páginas permanecem estáveis enquanto chegam itens novos.
{ "object": "list", "has_more": true, "data": [ { "object": "email", "id": "0192e1c4-7a3c-7a02-8e10-6c0f9d7a2b31", "...": "..." }, { "object": "email", "id": "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10", "...": "..." } ]}has_more informa se existe outra página na direção em que você estava paginando.
Percorrer todas as páginas
Seção intitulada “Percorrer todas as páginas”import { SpacePost } from "@spacepost/node";
const spacepost = new SpacePost();
let after: string | undefined;for (;;) { const { data, error } = await spacepost.emails.list({ limit: 100, after }); if (error) throw new Error(error.message); for (const email of data.data) console.log(email.id, email.last_event); if (!data.has_more) break; after = data.data[data.data.length - 1]!.id;}curl "https://api.spacepost.dev/emails?limit=100" -H "Authorization: Bearer $SPACEPOST_API_KEY"curl "https://api.spacepost.dev/emails?limit=100&after=0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10" -H "Authorization: Bearer $SPACEPOST_API_KEY"after = Nonewhile True: params = {"limit": 100, **({"after": after} if after else {})} page = requests.get("https://api.spacepost.dev/emails", headers=h, params=params).json() for email in page["data"]: print(email["id"], email["last_event"]) if not page["has_more"]: break after = page["data"][-1]["id"]Observações
Seção intitulada “Observações”- As listagens de e-mails omitem
htmletext; busque um e-mail específico para obter o corpo. - As listagens de domínios omitem
records; busque um domínio específico para obtê-los. - Um cursor malformado retorna
422 validation_error(“Invalid pagination cursor”).