API referenceExpiries

View a shared expiry

posthttps://api.expiryedge.com/v1/viewExpiry
Public - no API key60/min
Request
curl -X POST 'https://api.expiryedge.com/v1/viewExpiry?share_token=5c0e7a52-3f7e-4b3e-9a2e-1d2f0b6c9e11' \
  -H "Content-Type: application/json" \
  -d '{
  "password": "renew2026"
}'
Response
{
  "id": "exp_4Tq9sLm2",
  "name": "Northwind Dental - State Dental License",
  "type": "License",
  "priority": "High",
  "state": "todo",
  "expiry_date": "2026-10-15",
  "start_date": "2025-10-15",
  "notes": "Renew with the State Board of Dentistry at least 30 days ahead.",
  "is_done": false,
  "is_archive": false,
  "is_public": true,
  "has_workflow": true,
  "workflow_attachment_ids": [
    "wf_0"
  ],
  "assigned_to_user_full_name": "Priya Shah",
  "assigned_to_user_email": "priya@northwinddental.com",
  "assigned_by_user_full_name": null,
  "assigned_by_user_email": null,
  "created_at": "2026-09-27T14:05:00.000Z",
  "updated_at": "2026-09-27T14:05:00.000Z"
}

Returns display fields only. 403 when sharing is off; 401 with requiresPassword: true when a password is needed or wrong.

Query parameters

  • share_tokenstring
    The expiry's share token (the last segment of the share URL). Required here or in the body.

Body parameters

application/json
  • share_tokenstring
    Alternative to the query parameter.
  • passwordstring

Returns

200
Public display fields of the shared expiry.
  • idstring
  • namestring
  • typestring
  • prioritystring
  • statestring
  • notesstring
  • urlstring
  • start_datestring | null
  • start_timestring
  • start_timezonestring
  • expiry_datestring
  • expiry_timestring
  • expiry_timezonestring
  • custom_columnsobject
  • checklist_itemsarray of objects
  • checklist_completedany
    Checklist completion state as stored.
  • template_fieldsarray of objects | null
  • template_dataobject | null
  • template_namestring | null
  • template_iconstring | null
  • template_colorstring | null
  • is_recurringboolean
  • recurrence_typestring | null
  • recurrence_intervalinteger | null
  • recurrence_countinteger | null
  • recurrence_end_datestring | null
  • occurrence_numberinteger
  • fileUrlsarray of string
  • fileUrlstring
  • fileNamesarray of string
  • is_doneboolean
  • is_archiveboolean
  • is_publicboolean
  • created_atstring
  • updated_atstring
  • has_workflowboolean
  • workflow_attachment_idsarray of string
    Placeholders (wf_0, wf_1, ...); only the count is meaningful.
  • assigned_to_user_full_namestring | null
  • assigned_to_user_emailstring | null
  • assigned_by_user_full_namestring | null
  • assigned_by_user_emailstring | null
  • directory_entries_dataarray of objects

Errors

400
The request is missing required fields or contains invalid values.
401
The share link is password-protected and the password is missing or wrong.
403
Authenticated, but your role or organization does not allow this action.
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.