Skip to main content
You must sign in as an administrator of your PayFit company — API keys can only be created by an admin.

​
Log in to PayFit

Sign in to the PayFit dashboard with an administrator account. API keys give access to your own company’s data and can only be created by an admin.

​
Create your PayFit API key

PayFit API keys are created and managed from the Integrations area of your company dashboard.

1

Open the API access page

In the left sidebar, under My structure, click Integrations, then open the API access tab. Under Your API keys, click Create a key.

  • You can also go straight to the API access page once you are signed in: https://app.payfit.com/integrations/hub/api — PayFit redirects it to your company-specific URL, so it only works while logged in.
PayFit Integrations page with the API access tab and the Create a key button
2

Enter a name and select scopes

Enables actions: Create Collaborator, Create Contract, Get Collaborator, Get Collaborator Payslip, Get Contract, List Absences, List Collaborator Payslips, List Collaborators, List Collaborators Meal Vouchers, List Contracts, List Health Insurance Contracts, List Provident Fund Contracts, List Worked Time, Update Health Insurance Affiliation, Update Provident Fund Affiliation

In the Create a new API key dialog, type a name for the key in Name of the key. Then tick the scopes the key should grant. The Create button stays disabled until at least one scope is selected. Selecting the correct scopes is critical — if a required scope is missing, the matching actions return no data or fail with a permission error, so enable every scope the integration needs.

Create a new API key dialog showing the name field, scope checkboxes and the disabled Create button
3

Find scopes further down the list

The scope list is grouped by area and is scrollable. Scroll down past Employee access to reach the Presence and absences group, which contains time:read, and the Health insurance group, which contains health-insurance:read and health-insurance:write.

Lower part of the scope list showing the time and health-insurance scopes
4

Copy your API key

After clicking Create, PayFit shows Your PayFit API key is ready to use. Click Copy to copy the key, then click I have secured my API key to close the dialog.

  • The key is displayed only once and cannot be retrieved later — it will no longer be visible in PayFit after you close this window, so copy and store it securely before closing.
New API key dialog with the generated key value and the Copy button

Connect PayFit to StackOne using the key you just copied.

1

Paste the key into the API Key field

In StackOne Hub, paste the copied key into the API Key field. This is the only credential PayFit requires — StackOne sends it as a bearer token and automatically resolves your company from the key.

​
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 Key
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.