Authentication
How to authenticate requests to the Imploy REST API with an access token.
Send the token
Add the token to every request in the Authorization header, using the Bearer scheme. The base URL is https://app.imploy.com.au/api/integrations/v1.
curl "https://app.imploy.com.au/api/integrations/v1/me" \
-H "Authorization: Bearer imp_at_XXXX"
const res = await fetch("https://app.imploy.com.au/api/integrations/v1/me", {
headers: { Authorization: "Bearer imp_at_XXXX" },
});
const data = await res.json();
Check what the token can do
GET /me returns the connected organisation and the level for each area. Each area is read-write, read or none.
{
"organisation": "example-organisation",
"connection": "Example Client",
"access": {
"clients": "read-write",
"staff": "read",
"roster": "read",
"sites": "read",
"finance": "none",
"forms": "none",
"reports": "none",
"prospects": "none"
},
"expires_at": "2026-01-01T00:00:00+00:00"
}
Requests
Filters go in the query string.
- Lists can be comma separated (
?refs=a:1,a:2) or repeated (?refs[]=a:1&refs[]=a:2). - Booleans are
trueorfalse. - Object values are sent as JSON text.
Send a JSON object body with Content-Type: application/json.
PATCHonly changes the fields you send.- A body that is not a JSON object returns
400.
- Ids in the path are numbers. Shift refs (
a:123) and import batch ids are text. - Request bodies can be up to 64 KB.
Responses
Responses are JSON, are sent with Cache-Control: no-store, and never include the token. Errors always include a message.
| Status | Meaning |
|---|---|
200 | OK. Also returned for deletes, and for dry runs. |
201 | Created by a create endpoint. |
400 | The body is not a JSON object |
401 | The token is missing, invalid, disabled or expired |
403 | The token does not have the permission this endpoint needs |
404 | Unknown endpoint, or the record was not found |
413 | Request body over 64 KB |
422 | Validation failed, or the change is not allowed |
429 | Rate limit reached |
503 | Organisation integrations are turned off |
See Limits and errors for the error format.
Was this page helpful?