Skip to main content

Generating an API token

An API token authenticates StackOne requests to your Deel organization. You generate it in the Deel Developer settings and paste it into StackOne Hub.

1

Sign in to Deel

Sign in to the Deel account for the environment you are connecting:

  • ProductionDeel production sign-in
  • SandboxDeel demo sign-in
  • The steps below are identical in both environments; the screenshots show production.
  • Generate the token in the same environment you select in StackOne Hub — a production token does not work against the sandbox, and vice versa.
2

Open Organization settings

Click the Organization settings gear icon in the top bar.

The Deel home page with the Organization settings gear icon in the top bar highlighted
3

Open the Developer tokens page

In All Settings, scroll to the Services group in the left menu.

  • Click Developer to expand it.
  • Click Tokens.
The All Settings menu with Developer expanded and the Tokens entry highlighted
4

Generate a new token

On the Developer page, with the Tokens tab selected, click Generate new token.

The Developer page on the Tokens tab with the Generate new token button highlighted
5

Enter the token details

In Token details, type a name for the token in the Label field.

  • Label: StackOne Integration
  • Keep Organization token (Recommended) selected. A Personal token only reaches the resources your own user can access.
  • Click Next.
The Token details step with the Label field, the Organization token option and the Next button highlighted
6

Select the token scopes

Enables actions: Calculate EOR Employment Cost, Cancel Time Off Request, Create ATS Application, Create ATS Candidate, Create ATS Job, Create Contract, Create Group, Create Legal Entity, Create Manager, Create Organization Structure, Create Role, Create Time Off Request, Create Timesheet, Create Worker Relation, Create Worker Relation Type, Delete Group, Delete Legal Entity, Delete Organization Structure, Delete Timesheet, Delete Worker Relation, Delete Worker Relation Type, Get ATS Application, Get ATS Job Posting, Get Contract, Get EOR Hiring Guide By Country, Get Invoice, Get Organization, Get Organization Structure, Get Person, Get Timesheet Preset, Get Work Schedule And Holidays, List ATS Applications, List ATS Candidates, List ATS Departments, List ATS Employment Types, List ATS Job Postings, List ATS Jobs, List ATS Locations, List ATS Offers, List Adjustment Categories, List Contract Templates, List Contracts, List Deel Invoices, List Departments, List EOR Benefits, List EOR Job Scope Templates, List GP Payroll Events By Legal Entity, List GP Worker Payslips, List Groups, List Invoices, List Legal Entities, List Managers, List Offboarding, List Onboarding Employees, List Organization Structures, List Organization Tasks, List Payments, List People, List People Custom Fields, List Roles, List Time Off Policies, List Time Off Requests, List Time Tracking Shift Rates, List Time Tracking Shifts, List Timesheet Presets, List Timesheets, List Webhooks, List Worker Relation Types, List Worker Relations, List Working Locations, Retrieve A List Of ATS Teams, Review Time Off Requests, Review Timesheet, Update Group, Update Legal Entity, Update Organization Structure, Update Role, Update Time Off Request, Update Timesheet, Update Worker Relation Type

In Select scopes, expand each scope group and tick the scopes the integration needs, then click Next. The scopes required by this connector are listed below.

The Select scopes step with a scope group header, a ticked scope and the Next button highlighted
7

Set the permission level

In Permission levels, select Organization-level access so the token can read data across the whole organization, then click Next.

  • Group-level access limits the token to specific groups; choosing Organization-level access also removes the Select groups step from the wizard.
The Permission levels step with Organization-level access selected and the Next button highlighted
8

Review the sensitive data settings

In Sensitive data, leave both toggles off so StackOne can read the fields it syncs, then click Next.

  • Hide all personally identifiable information (PII) — leave off.
  • Hide Sensitive Employment Information — leave off.
The Sensitive data step with both toggles highlighted and left off, and the Next button highlighted
9

Review and generate the token

In Review, check the token type, label, selected scopes and permission level, then click Generate.

The Review step summarizing the token settings with the Generate button highlighted
10

Copy the token

In the New token was generated dialog, click Copy next to the token value and store it securely for use later.

  • The token is shown only once. If you close the dialog without copying it, you must generate a new token.
  • Paste it into the API Token field in StackOne Hub.
  • Click Close.
The New token was generated dialog with the token value masked and the Copy button highlighted

Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • API Token
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.