How to use and connect to the Simployer One API

How do I generate an API access token?

You need the Owner permission to create an API access token in Simployer One. The API gives access to all employee information in your account, so only Owners can generate tokens, to keep sensitive employee data protected.

To generate a token:

1. Go to Settings > Access tokens.
2. Choose whether the token should allow access to the Public API, the Provisioning API, or both.
3. Generate the token.

Important: Your access token is shown only once, at the moment you create it. Copy it and store it somewhere safe right away, since you won't be able to view it again after this.

The token is tied to the user who created it. If that user's permissions change, or the user is removed from Simployer One, the token becomes invalid.

How do I authenticate my API requests?

To authenticate your account when using the Simployer One API, include your secret access token in the request.

Pass your access token in the Authorization header of each API request.

What query parameters does the API support?

The Simployer One API supports the following query parameters:

• select
• relations
• filters
• limit
• offset
• sort

Not every endpoint supports every parameter. Check the documentation for the specific endpoint you're working with to see which query parameters it permits.