API reference / Watchlists

List recent deliveries

Written and maintained by The ProspectAPIs team

GET/v1/watchlists/:id/deliveries

GET /v1/watchlists/:id/deliveries is the ProspectAPIs operation listWatchlistDeliveries, in the Watchlists group of the REST API. The last 50 deliveries for a watchlist and their outcome. Free. Cost: free. Send your API key as a Bearer token in the Authorization header.

How this fits with the rest of the watchlists API, with worked examples, is in the watchlists guide.

Parameters

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

Recent deliveries.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/deliveries \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/deliveries", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/watchlists/3f6c1d2e-8b4a-4f7e-9c21-5a0d7e9b4c13/deliveries",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

This call is free: it never spends credits or free records, so you can call it as often as the rate limit allows. Metered calls on the same key report your balance after each response in X-Credits-Remaining, and GET /v1/account shows it at any time.

Related

The watchlists guide covers this area end to end. Previous operation: Send a test delivery. Next operation: Account balance. Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.