The Wizard Application API lets your developers and other systems read and update your data, such as jobs, candidates, leads, bookings and content, so information flows between your tools without anyone copying it across.
Before you start
- API access is on the Professional and Enterprise plans.
- 10,000 requests a month are included, and the count resets each month. Requests beyond that are charged, and the API keys page shows an estimate as you go.
Create an API key
-
Open API Keys
Open Settings from the gear icon in the top bar and choose API Keys.
-
Name it
Create a new key and name it after what will use it, such as Website forms or Accounts sync.
-
Give it only what it needs
Choose its permissions: read or write access to jobs, candidates, companies, bookings, leads, content, assets or users. A key that only needs to read jobs should not be able to change candidates. If it can create users, you need to accept that each new user is a paid seat.
-
Set an expiry date
Choose when the key stops working, or leave it with no expiry.
-
Copy it now
Generate the key and copy it straight away. It is only shown once, so store it somewhere safe, such as your password vault.
Look after your keys
- Switch a key off to stop it working without deleting it.
- Delete a key you no longer need, or one you think has been exposed, and create a new one.
- Check your usage on the same page: requests used this month, how many free requests remain and any paid requests.
One key per connection. Give each system its own key, so you can switch one off without breaking the others.
Your developers will find everything they need in the API documentation.