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

Open Admin Settings

Sign in to your Culture Amp account, then click Settings in the top right navigation menu to open your account’s Admin Settings.

2

Open the API section

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

3

Create the API Credential

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

Click Create API Credential and follow the prompts. Assign the read permissions listed below.

  • employees-read — list and get employees
  • employee-demographics-read — employee demographics
  • performance-evaluations-read — performance cycles and manager reviews
4

Copy the credential

Copy the Client ID and Client Secret across.

1

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.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.