For needs the marketplace doesn’t cover, Illizeo exposes a REST API documented OpenAPI 3.1. OAuth 2.0 or API key authentication, reasonable rate limits, bidirectional webhooks.
Main endpoints #
| Domain | Verbs | Quotas |
|---|---|---|
| /v1/employees | GET, POST, PATCH, DELETE | 10,000 / hour |
| /v1/leaves | GET, POST, PATCH | 10,000 / hour |
| /v1/payroll | GET | 1,000 / hour |
| /v1/documents | GET, POST | 5,000 / hour |
| /v1/attendance | GET, POST | 50,000 / hour |
Step-by-step #
-
Create an application #
Settings → API → Applications → New. Name, scopes, allowed IPs (optional).
-
Get credentials #
OAuth Client ID + Client Secret, or plain API key. The Secret is shown only once, store it in your vault.
-
Test with curl or Postman #
Postman collection provided. curl examples in the documentation.
-
Implement #
Official SDKs: Node.js, Python, PHP, Java. Community: Go, Ruby, .NET.
-
Monitor #
API Usage dashboard: calls, P95 latency, 4xx/5xx errors, remaining quota.
Data format #
All responses in JSON. Cursor-based pagination (RFC 5988). RFC 7807 errors (Problem Details). Standard URL filters: ?filter[status]=active&sort=-created_at&page[size]=50.
FAQ #
API for what use cases?
Sync with in-house IS, BI export, HR automation (create profile from ATS, etc.).
Versioning?
v1 stable. 12-month notice before deprecation. Posted in changelog.
Sandbox?
Free sandbox tenant with fake data. Ideal for risk-free development.
Recommended auth?
OAuth 2.0 for user apps. API key for server-to-server jobs.
