Skip to main content
API credentials can only be created by an Admin user with Account Owner permissions. Credentials are generated at the account level and grant access to all of the account’s data scoped into their permissions, so treat them with caution and never share them with parties you do not trust.

​
Generating API Credentials

Culture Amp’s API uses the OAuth 2.0 Client Credentials Flow, which requires valid API credentials created in your account’s Admin Settings. Your credential consists of a Client ID and a Client Secret.

1

Log in to Culture Amp

Sign in to your Culture Amp account as an Admin user with Account Owner permissions.

2

Open Admin Settings

Click the Settings item in the top right navigation menu to open your account’s Admin Settings.

3

Open the API section

In the left-hand navigation within your Settings, click API.

4

Create the API Credential

Click Create API Credential and follow the prompts, assigning the read permissions your integration needs. Then copy the Client ID and Client Secret and store them securely for use later.

​
Scope (optional)

The Scope is optional. Leave it blank to request the connector’s three read scopes (employees-read, employee-demographics-read, performance-evaluations-read). To narrow access, enter only the comma-separated permissions you need - StackOne adds the target-entity prefix automatically.

1

Choose the permissions

Enables actions: Get Employee, Get Manager Review, Get Performance Cycle, List Demographics By Employee, List Employees, List Manager Reviews, List Manager Reviews By Employee, List Manager Reviews By Performance Cycle, List Performance Cycles

Enter the read permissions your integration needs, comma-separated with no spaces.

  • employees-read — list and get employees
  • employee-demographics-read — employee demographics
  • performance-evaluations-read — performance cycles and manager reviews
  • Example: employees-read,performance-evaluations-read

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Culture Amp:
1

Open the connector

Log in to StackOne, open Connectors, and select Culture Amp.
2

Choose actions and events

  • Click Add Profile.
  • If the connector offers more than one authentication method, set the Auth Method filter to OAuth 2.0 (Client Credentials).
  • Select the actions, and any events, to enable for this Connector Profile.
  • Click Continue.
3

Set up authentication

  • Select Authentication Type as OAuth 2.0 (Client Credentials).
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
    • Scope (Optional)
  • Click Create Profile.
Congratulations! The new Connector Profile now shows up on the connector page. If you created it as a project member rather than an admin, it starts disabled until a project admin enables it. You can now continue to Link Accounts for Culture Amp.