API pagination and filters

cURL

# First page
curl "https://api.postal.so/emails?limit=100" \
  -H "Authorization: Bearer $POSTAL_API_KEY"

# Next page: the ID of the last item received
curl "https://api.postal.so/emails?limit=100&after=019a1b2c-4d5e-7f60-8a9b-0c1d2e3f4a5b" \
  -H "Authorization: Bearer $POSTAL_API_KEY"

Node.js

async function listAll(path) {
  const items = [];
  let after;

  do {
    const url = new URL(path, 'https://api.postal.so');
    url.searchParams.set('limit', '100');
    if (after) url.searchParams.set('after', after);

    const response = await fetch(url, {
      headers: { Authorization: `Bearer ${process.env.POSTAL_API_KEY}` },
    });
    const page = await response.json();

    items.push(...page.data);
    after = page.has_more ? page.data.at(-1).id : undefined;
  } while (after);

  return items;
}

const bounces = await listAll('/emails?status=bounced');

Python

import os
import requests

def list_all(path, **filters):
    items, after = [], None

    while True:
        params = {"limit": 100, **filters}
        if after:
            params["after"] = after

        page = requests.get(
            f"https://api.postal.so{path}",
            headers={"Authorization": f"Bearer {os.environ['POSTAL_API_KEY']}"},
            params=params,
            timeout=10,
        ).json()

        items.extend(page["data"])
        if not page["has_more"]:
            return items
        after = page["data"][-1]["id"]

bounces = list_all("/emails", status="bounced")

PHP

function listAll(string $path, array $filters = []): array
{
    $client = new \GuzzleHttp\Client(['base_uri' => 'https://api.postal.so']);
    $items = [];
    $after = null;

    do {
        $page = json_decode($client->get($path, [
            'headers' => ['Authorization' => 'Bearer '.getenv('POSTAL_API_KEY')],
            'query' => [...$filters, 'limit' => 100, ...($after ? ['after' => $after] : [])],
        ])->getBody(), true);

        array_push($items, ...$page['data']);
        $after = $page['has_more'] ? end($page['data'])['id'] : null;
    } while ($after !== null);

    return $items;
}

$bounces = listAll('emails', ['status' => 'bounced']);