Diese technische Dokumentation ist auf Englisch verfügbar.
LeitfädenGetting started with the ExpiryEdge API
Make your first API call in a few minutes.
Step 1: Get an API key
An admin opens Settings > API keys, clicks Create API key, picks Editor or Viewer, and copies the key (shown once). Details: API keys.
Save the address and key in your terminal:
export BASE="https://api.expiryedge.com/v1"
export TOKEN="ee_live_..."Keep the key secret, like a password.
Another way: sign in with email and password
To act as a specific user, exchange their email and password for a session token (valid 30 days):
curl -s "$BASE/login" -H 'Content-Type: application/json' \
-d '{"email":"you@yourcompany.com","password":"YOUR-PASSWORD"}'Copy accessToken from the response into TOKEN.
Step 2: Make your first request
curl -s "$BASE/getPaginatedExpiries?page=1&limit=5" -H "Authorization: Bearer $TOKEN"A list of your expiries means it works. Every request needs the Authorization: Bearer $TOKEN header.
Step 3: Pick what you want to do
Manage API keys
API keys
Create a deadline with reminders, add contacts, send a document request
Common workflows
Attach a file to a deadline
Attach files to an expiry
Upload files to Documents
Upload and manage files in Documents
Write pages in Docs
Create and publish Docs pages
Sync new or changed records
Pagination and polling
Get notified instantly
Webhooks
Try the next API version
v2 preview
See every endpoint
openapi.yaml
How file uploads work
- Ask for an upload link (file name, type, size). It works once, for 15 minutes.
- PUT the file to that link.
- Confirm the upload.
Max 50 MB per file. PDFs, images, Office files, text/CSV, audio, video and archives are accepted. HTML, SVG and XML are not.
When something goes wrong
| Code | Meaning | Fix |
|---|---|---|
| 400 | Missing or invalid field | Read the error message. |
| 401 | Key or token missing, wrong, revoked or expired | Check the whole key was copied, or get a new one. |
| 403 | Role too low or plan limit reached | Use an Editor key or check your plan. |
| 404 | Wrong ID, or another organization's record | Check the ID. |
| 429 | Too many requests | Wait Retry-After seconds. |
| 500 | Server error | Retry later. Send support the requestId if it persists. |
All codes: Errors.