List collection requests

gethttps://api.expiryedge.com/v1/getAllCollectionRequests
any role (admin, editor or viewer) in the organization60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getAllCollectionRequests?templateId=tpl_W9onboard' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "requests": [
    {
      "id": "req_9WkT",
      "organization_id": "org_northwind",
      "name": "Q4 insurance refresh",
      "due_date": "2026-10-15T00:00:00.000Z",
      "template_id": "tpl_W9onboard",
      "template_name": "New client onboarding - Northwind Dental",
      "contact_id": "c_8Hk2pQ",
      "contact_name": "Dana Whitfield",
      "contact_email": "dana@northwinddental.com",
      "expiry_id": "exp_4Tq9sLm2",
      "group_id": null,
      "has_password": false,
      "expires_at": "2026-10-31T23:59:59.000Z",
      "status": "viewed",
      "archived": false,
      "paused": false,
      "sent_at": "2026-09-27T14:05:00.000Z",
      "viewed_at": "2026-09-27T15:10:00.000Z",
      "completed_at": null,
      "cancelled_at": null,
      "resend_count": 0,
      "last_resent_at": null,
      "draft_filled_count": 3,
      "draft_total_fields": 5,
      "draft_updated_at": "2026-09-27T15:20:00.000Z",
      "next_reminder_at": "2026-09-28T13:00:00.000Z",
      "reminders_sent_count": 0,
      "email_stats": {
        "sent_count": 1,
        "delivered_count": 1,
        "opened_count": 1,
        "last_event_at": "2026-09-27T15:09:30.000Z"
      },
      "reply_received": false,
      "reply_at": null,
      "reply_snippet": null,
      "latest_review_status": null,
      "review_approved_count": null,
      "review_total_fields": null,
      "completed_field_count": null,
      "created_by": "u_71bXq",
      "created_by_name": "Priya Shah",
      "created_at": "2026-09-27T14:05:00.000Z",
      "updated_at": "2026-09-27T15:20:00.000Z"
    }
  ]
}

Returns every matching request in the organization, newest sent first; unbounded (no pagination). Archived requests are included (filter on archived). Open requests past expires_at are returned (and saved) as expired. The handler does not check the HTTP method. On GET filters are read from the query string, on other methods from the JSON body.

Query-Parameter

  • templateIdstring
  • contactIdstring
  • statusstring
    Erlaubtpendingviewedcompletedcancelledexpired
  • expiryIdstring

Rückgabe

200
Requests.
  • requestsarray of objectserforderlich

Fehler

401
Missing, expired or invalid bearer token.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.