List expiries with filters and pagination
post
https://api.expiryedge.com/v1/getPaginatedExpiriesany role500/min
Anfrage
curl -X POST 'https://api.expiryedge.com/v1/getPaginatedExpiries' \
-H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"page": 1,
"limit": 25,
"metric": "future",
"futureDurationDays": 30,
"type": "License",
"sortBy": "expiry_date",
"sortDirection": "asc"
}'Antwort
{
"data": [
{
"id": "exp_4Tq9sLm2",
"name": "Northwind Dental - State Dental License",
"type": "License",
"expiry_date": "2026-10-15",
"priority": "High",
"state": "todo",
"is_done": false,
"is_archive": false,
"has_share_password": false,
"assigned_to": "u_71bXq",
"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
}
],
"expiries": [
{
"id": "exp_4Tq9sLm2",
"name": "Northwind Dental - State Dental License",
"type": "License",
"expiry_date": "2026-10-15"
}
],
"pagination": {
"total": 27,
"totalPages": 2,
"currentPage": 1,
"page": 1,
"limit": 25,
"optimized": true
}
}Offset pagination with page / limit (default 10, max 10000). With complex filters the server scans at most
5000 records in memory (pagination.optimized: false). Prefer listExpiryChanges for polling.
pageintegerStandard1min: 1limitintegerValues above 10000 are clamped.Standard10min: 1 · max: 10000metricFilterstringDashboard metric card to filter by.ErlaubttotalcompletedexpiredarchivedactivetodayupcomingThisMonthfuturemetricstringDashboard metric card to filter by.ErlaubttotalcompletedexpiredarchivedactivetodayupcomingThisMonthfuturetypeFilterstringExpiry type name, orAll. Aliastype.typestringpriorityFilterstringPriority, orAll. Aliaspriority.prioritystringstateFilterstringWorkflow state, orAll.searchQuerystringText search. Aliassearch.searchstringselectedTeamstringTeam id;'0'= all. Aliasteam_id.team_idstringfolder_idstring | nullFolder id;root, null or empty string = unfiled only.include_subfoldersbooleanStandardfalseassignedToMebooleanStandardfalseassignedUserstringUser id of the assignee.futureDurationDaysinteger or stringWindow formetric: future, in days, orall.notifyNonebooleanOnly records with no queued reminder or no live contact.StandardfalsesortBystringA field name, or<templateId>:::<fieldKey>for a template field. Invalid values fall back toexpiry_date.Standardexpiry_datesortDirectionstringErlaubtascdescStandardasc
200
One page of expiries.
data and expiries hold the same array.dataarray of objectserforderlichexpiriesarray of objectserforderlichSame array asdata(kept for older clients).paginationobjecterforderlich
400 | The request is missing required fields or contains invalid values. |
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. |
