Quickstart
Create an access token and make your first API call.
This takes about five minutes. You need to be an organisation owner or a Superadmin.
Create a token
In Imploy, go to Settings > Integrations and create an access token. Give it a name and set Clients, Staff and Roster to Read. Leave the other areas disabled.
Copy the secret
The secret starts with imp_at_ and is shown once. Store it somewhere safe, like a password manager or your secrets store.
Check the token works
Call GET /me. It returns your organisation and what the token can do.
List some clients
Call GET /clients. You get a page of clients with a meta block for paging.
curl https://app.imploy.com.au/api/integrations/v1/me \
-H "Authorization: Bearer imp_at_XXXX"
curl "https://app.imploy.com.au/api/integrations/v1/clients?per_page=5" \
-H "Authorization: Bearer imp_at_XXXX"
const base = "https://app.imploy.com.au/api/integrations/v1";
const headers = { Authorization: `Bearer ${process.env.IMPLOY_TOKEN}` };
const me = await fetch(`${base}/me`, { headers }).then((r) => r.json());
console.log(me.organisation, me.access);
const clients = await fetch(`${base}/clients?per_page=5`, { headers }).then((r) => r.json());
console.log(clients.meta, clients.data);
import os
import requests
base = "https://app.imploy.com.au/api/integrations/v1"
headers = {"Authorization": f"Bearer {os.environ['IMPLOY_TOKEN']}"}
print(requests.get(f"{base}/me", headers=headers).json())
clients = requests.get(f"{base}/clients", params={"per_page": 5}, headers=headers).json()
print(clients["meta"], clients["data"])
A 401 means the token is missing, wrong, disabled or expired. A 403 means the token doesn't have the permission the endpoint needs.
Treat the token like a password. Keep it out of source control and front end code.