How do I create an API token?

Last updated: June 3, 2026

An API token authenticates calls to the Onboarded API for one account. You create it in Account Settings, give it a name, and copy it into whatever system will call the API.

Before you start

  • Access to your account's Account Settings.

  • A place to store the token securely — it grants API access to your account.

Create the token

A token is scoped to the account and mode it's created in. Confirm you're in the mode you want it to act on — test or live — before you generate it.

  1. Go to Account Settings → API Tokens.

  2. Select Create Token. A panel titled Create API token opens.

  3. Enter a Name that describes what the token is for — for example, Employee sync or Onboarding automation. The name is how you'll recognize the token later, so make it specific.

  4. Select Create. You'll see API token created, and the new token appears in the list.

Copy and store it

  1. Find your token in the list. It displays masked — the first few characters followed by dots. Use the copy control on its row to copy the full value.

  2. Paste it into the system that will call the Onboarded API. Treat it like a password — anyone holding the token can act on your account through the API.

A token only works for the mode it was created in. Test mode and live mode are separate, so a token follows whichever one you generated it in. A live-mode token reaches only your live-mode data — clients, employees, employers, jobs, forms deployed to live mode, policies, and integrations — and a test-mode token reaches only test-mode data. Generate a separate token in each mode you need to call.

Verify

Your token shows in the API Tokens list with the Name you gave it, who created it, and the date. For how to include the token in requests, open the Docs link on the API Tokens page.

To revoke a token, select the trash icon on its row. You'll see API token deleted, and any integration still using that token stops authenticating immediately — so confirm nothing depends on it before you delete.

Related

  • Using the Onboarded API (Reference — coming)