- OAuth API - For accessing employee census data, survey metadata, and aggregate survey results
- Reporting API - For accessing raw survey response data with individual-level details
API 1: OAuth API (Employee & Survey Data)
Purpose
Use the OAuth API to retrieve:- Employee roster, demographics, and organizational hierarchy
- Survey metadata and configuration
- Aggregate survey scores and participation data
- Survey comments (optional)
Culture Amp API Integration Checklist
To: Culture Amp Account Administrator (People Ops / IT) Subject: Technical Requirements for People Data Integration To enable our application to retrieve employee census and engagement data, please generate API credentials in the Culture Amp platform.Phase 1: Generate OAuth Credentials
-
Log in to Culture Amp
- Navigate to the Settings menu (gear icon in the top right corner).
- Select Account Administrator from the dropdown.
- Note: You must have Account Admin privileges to access the Developer settings.
-
Access Developer Settings
- In the administration panel, look for the Developer section (usually on the left sidebar or under “Account Settings”).
- Click on API Keys or Credentials.
-
Create New Credential
- Action: Click the “Add Credential” or “Create New Key” button.
- Name:
Human Intelligence Analytics Integration - Type: Ensure this is set to API (not SFTP or HRIS Sync).
- Configure Permissions (Scopes) Culture Amp manages access via “Scopes.” Please ensure the following scopes are added to the list for this key. Note: Depending on your configuration, you may need to type these in or select them from a list.
Phase 2: OAuth Credential Handover
Please securely transmit the following two values.- Client ID
- Client Secret
API 2: Reporting API (Raw Survey Responses)
Purpose
Use the Reporting API to retrieve:- Individual survey responses with question-level detail
- Raw survey data for custom analysis
- Time-series survey data with date filtering
Important Limitations
- Only provides access to surveys with the “raw data option” enabled
- Raw data option must be enabled before survey launch (cannot be enabled retroactively)
- Does not anonymize or de-identify survey responses
- Email and employee_id are null for ad-hoc surveys
Phase 1: Enable Reporting API Access
- Request Feature Activation
- Contact Culture Amp Support via a Support Conversation
- Reply with “Ask a Person” to speak with a Product Support Specialist
- Request activation of the Reporting API for your account
- Assign Survey Data Analyst Role
- At least one user must have the “Survey Data Analyst” role
- This role is required to generate API tokens
- Enable Raw Data on Surveys
- For each survey you want to access via the API:
- Before launching, enable the “raw data option” in survey settings
- This cannot be changed after launch
Phase 2: Generate Reporting API Token
- Generate Token (must be done by user with Survey Data Analyst role)
- Open your profile:
https://<subdomain>.cultureamp.com/my/profile - Click Generate in the API Token field
- Copy the token immediately and store securely
- The token is only shown once and should be treated as a password
- Open your profile:
- Token Security
- If lost or compromised, click Regenerate in your profile
- Regenerating invalidates the previous token
Phase 3: Reporting API Credential Handover
Please securely transmit the following values:- Account Subdomain (usually your company name)
- API Username (email)
- API Token
Summary
Once both APIs are configured:- OAuth API provides employee census and aggregate survey data
- Reporting API provides individual survey responses with detailed question data