ParasendDocs
Sign in Start free

List deliveries

GET/v1/deliveries

Lists your deliveries a page at a time (limit, cursor). Each row carries its kind. status is where a delivery is in its life; activity such as reminders and opens is in last_activity, never in status.

Query parameters

  • qstring

    Free text, 2–200 characters, matched case-insensitively as part of the delivery title, the recipient's name or the recipient's e-mail, or exactly against a delivery id. Never matches personal codes or phone numbers — use pin for a personal code. % and _ are ordinary characters.

  • pinstring

    The recipient's personal code (e.g. kennitala), exact match only; spaces and hyphens are ignored (120389-4569 = 1203894569). A part of a code matches nothing.

  • recipient_emailstring · email

    The recipient's e-mail address, exact match, case-insensitive.

  • created_beforestring · date-time

    Only deliveries created strictly before this time. With created_after, a date range.

  • sortstring

    created_desc (default) newest first; created_asc oldest first; title_asc / title_desc by title, case-insensitive; recipient_asc / recipient_desc by the recipient's name, else e-mail, else phone, case-insensitive; status_asc / status_desc by status in lifecycle order — on its way (created, paper_pending_approval, notified, paper_dispatched, opened, authenticated, auth_failed), then received (confirmed, delivered, evidence_sealed), then ended without delivery (expired, revoked, bounced, consignment_failed). Within one title, recipient or status the newest comes first. A cursor is only valid with the sort it was issued under (otherwise invalid_request / cursor_invalid).

    One of created_desc created_asc title_asc title_desc status_asc status_desc recipient_asc recipient_desc
    Default "created_desc"

Returns

200 application/json. Paginated list.

Errors have one shape; see Errors for every code.