API-Referenz

v1.0.0 · 429 Endpunkte

Alle Endpunkte mit Parametern, Request-Body und Antwort.

Basis-URL
https://api.expiryedge.com/v1
Authentifizierung
Authorization: Bearer ee_live_...

Senden Sie Ihren API-Schlüssel als Bearer-Token.

Beispiel: Expiries abrufen
Anfrage
curl 'https://api.expiryedge.com/v1/getPaginatedExpiries?page=1&limit=10&sortBy=expiry_date' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
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
  }
}
/

Auth

Sign in, registration, email verification, passwords and sessions.

16

Users & Team

Current user, organization users, teams, invitations, availability and backup rules.

32

Expiries

Deadlines, renewals, licenses and other dated records.

15

Expiry Types

Organization-defined categories for expiries.

7

Reminders & Notifications

Per-expiry reminder sequences, upcoming notifications, in-app notifications and test sends.

22

Recurrence

Recurring expiries and renewal history.

2

Bulk Operations

Operations that act on many expiries at once.

9

Contacts

People who receive reminders, and contact groups.

14

Folders

Folders for organizing expiries.

5

Templates

Industry templates and custom expiry templates.

7

Email Templates

Custom reminder email templates.

6

Document Collection

Request documents and information from clients, review submissions and automate requests.

34

Document Collection (Public)

Endpoints used by the recipient of a collection request link (request token, optional password).

7

Compliance Clients & Projects

Clients, projects and the compliance catalog.

21

Compliance Portals

Shareable read-only compliance portals.

6

Directory

Directory of vendors, locations, assets and other entities attached to expiries.

7

Workflows

Workflow checklists, runs, schedules and expiry attachments.

40

Comments & Activity

Expiry comments, workflow comments and the activity log.

11

Change Feeds

Cursor-paginated feeds for sync scripts.

2

Document Intelligence

AI document extraction and import column mapping.

6

Settings

Organization, reminder, escalation, webhook and notification settings.

19

Billing & Add-ons

Subscriptions, pricing, invoices, add-ons and additional licenses.

25

Usage & Limits

Plan limits, usage counters and storage.

11

Integrations

Asana, ClickUp and other third-party integrations.

38

Files & Documents

Files in Documents (folder files), Docs pages and their attachments, and files attached to expiries. Uploads use a 3-step flow: get an upload URL, PUT the file, then complete. See docs/api/guides/.

19

v2 (preview)

Resource-style preview of the next API version (expiries and contacts). REST paths and verbs, one error envelope, 201/204 conventions, cursor pagination. v1 is unchanged.

48