Planned
Webhooks
Signed events for new hires, leavers, applications and approvals, sent to your endpoint.
Build on LuraPlus
A REST API over the same data your team works with. Keys belong to one workspace and can be revoked at any time.
# List jobs in your workspace
curl "$LURAPLUS_API_URL/api/jobs" \
-H "x-api-key: $LURAPLUS_API_KEY"Quickstart
Your first request in three steps
Create a key
An admin opens Settings, then API keys, and generates a key. Copy it straight away: it is shown only once.
Send the header
Add x-api-key to every request. The key belongs to one workspace, so you never send a workspace ID.
Read the response
JSON in, JSON out. Errors return an HTTP status and a message that says what went wrong.
Endpoints
What you can reach today
These are the endpoints documented during the beta. Requests are scoped to the key's workspace and to the modules on its plan.
| Method | Path | What it does |
|---|---|---|
| GET | /api/jobs | List jobs in the workspace |
| GET | /api/jobs/:id | Get one job |
| GET | /api/jobs/:jobId/candidates | List the candidates for a job |
| GET | /api/candidates | List candidates |
| POST | /api/candidates | Add a candidate to a job: name, jobId and a CV file as multipart form data |
| GET | /api/users | List people in the workspace |
| GET | /api/departments | List departments |
| GET | /api/leave-requests | List leave requests |
| GET | /api/time-entries | List time entries |
Good practice
Keys, limits and errors
Keep keys server-side. Never put a key in a browser or mobile app. Send it in the x-api-key header, and rotate it by generating a new key and revoking the old one.
Base URL. During the beta, ask us for your API base URL and set it as LURAPLUS_API_URL, as in the samples above.
Limits. Cache what you can and avoid tight polling loops. Per-key rate limits and scopes arrive with the versioned API.
Errors. Every error has an HTTP status and a message.
- 401: The key is missing or not valid.
- 402: Your workspace does not have the module this route belongs to.
- 403: The workspace is inactive, or the request names a different workspace than the key.
- 404: The record does not exist in the key's workspace.
- 423: The workspace or module is read-only, so writes are refused.
Coming next
Webhooks
Get started
Run your people operations in one place
Try every module free for 14 days, no card required. Core HR stays free after the trial.