API-Referenzv2 (preview)

Get a Document Collection request

Vorschau
gethttps://api.expiryedge.com/v2/collection-requests/{id}
any member of the request's organization60/min
Anfrage
curl 'https://api.expiryedge.com/v2/collection-requests/req_123' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "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"
}

Pfadparameter

  • idstringerforderlich

Rückgabe

200
The request.
  • idstring
  • organization_idstring
  • namestring | null
  • template_idstring
  • template_namestring
  • contact_idstring
  • contact_namestring
  • contact_emailstring
  • expiry_idstring | null
  • group_idstring | null
  • statusstring
    Erlaubtpendingviewedcompletedcancelledexpired
  • has_passwordboolean
  • archivedboolean
  • pausedboolean
  • expires_atstring | null
  • due_datestring | null
  • sent_atstring
  • viewed_atstring | null
  • completed_atstring | null
  • cancelled_atstring | null
  • resend_countinteger
  • latest_review_statusstring | null
  • created_bystring
  • created_atstring
    UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
    format: date-time
  • updated_atstring
    UTC timestamp, ISO 8601. Every v1 response uses this form, never a raw Firestore Timestamp ({_seconds, _nanoseconds}).
    format: date-time

Fehler

401
Missing, invalid or expired token (UNAUTHORIZED).
403
Your role can't do this, or your account has no organization (FORBIDDEN).
404
No such record in your organization (records in other organizations are also 404).
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.