List Document Collection requests

Vorschau
gethttps://api.expiryedge.com/v2/collection-requests
any member of an organization60/min
Anfrage
curl 'https://api.expiryedge.com/v2/collection-requests?sort=-created_at&limit=50' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "data": [
    {
      "id": "req_3Hs8",
      "organization_id": "org_northwind",
      "name": "W-9 for 2026",
      "template_id": "tpl_W9x2",
      "template_name": "W-9",
      "contact_id": "c_8Hk2pQ",
      "contact_name": "Priya Shah",
      "contact_email": "priya.shah@northwinddental.example",
      "expiry_id": "exp_4Tq9sLm2",
      "status": "pending",
      "has_password": false,
      "archived": false,
      "paused": false,
      "sent_at": "2026-09-27T14:30:00.000Z",
      "resend_count": 0,
      "created_at": "2026-09-27T14:30:00.000Z",
      "updated_at": "2026-09-27T14:30:00.000Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true
}

Newest first by default, cursor-paginated. Combine two or more filters only with sort=id. The link token hash, password hash and the recipient's unsubmitted draft are never returned.

Query-Parameter

  • statusstring
    Stored status (pending, viewed, completed, cancelled, expired).
  • template_idstring
  • contact_idstring
  • expiry_idstring
  • sortstring
    Erlaubt-created_atidStandard -created_at
  • cursorstring
    Opaque next_cursor from the previous page. Only valid with the same sort.
  • limitinteger
    Page size, 1-100 (values above 100 are clamped; default 50).
    Standard 50min: 1 · max: 100

Rückgabe

200
A page of requests.
  • dataarray of objectserforderlich
  • next_cursorstring | nullerforderlich
  • has_morebooleanerforderlich

Fehler

400
Invalid parameters or body (VALIDATION_FAILED; details names the fields).
401
Missing, invalid or expired token (UNAUTHORIZED).
403
Your role can't do this, or your account has no organization (FORBIDDEN).
405
Wrong HTTP method for this path; the Allow header lists the valid ones.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.