What can I learn from this page? | Learn more from commonly asked customer questions about the Culture Amp API. |
Who is this guide for? | Account Admins |
Note:
Our API is RESTful, allowing one-way outbound data retrieval. Currently, it doesn't support data ingestion.
Data available from the API is limited to what is currently listed in the Culture Amp API Developer Portal.
Access to the API is included as part of your normal Culture Amp subscription fees and is there is no additional cost.
To learn more about the set up process, check out our instructional guide.
If you are having an issue with the API, don't hesitate to reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.
What can my organisation use the API for?
Culture Amp's API can be used programmatically by customers to fulfil a large variety of powerful use cases.
Most commonly these take the form of:
Deepening people insights and creating bespoke reporting or analytics solutions.
Connecting Culture Amp to other apps employees use each day to support common workflows.
Automating data management across apps & data stores.
Creating new or custom workflows that incorporate data from the API.
Eliminating tasks that have low value or are repetitive to free up time and refocus on employee experience.
Let's take a look at each of these categories with some examples to deepen your understanding.
Deeper People Insights and Bespoke Analytics
The API can be used to enrich your people analytics by leveraging Culture Amp data on-demand and combining it with other sources to create even more powerful insights.
Centralise, combine and refine your people data with other financial, operational, sales, product or HR data to expand your picture of the employee experience.
Build the reporting, visualisations and dashboards your leaders need to stay informed and realize greater business value from your people data.
Example:
Extracting performance ratings data for employees to run quartile analysis and more easily stratify and bucket employees by performance, enabling the identification of improvement opportunities.
API Use Case Commonly Enabled via:
ETL (Extract, Transform, Load) & Pipeline Tools
Business Intelligence and Visualisation Tools
Analytics Platforms
Databases, Data Warehouses and Data Lakes
Connecting Culture Amp to Other Apps
Embed Culture Amp into your existing workflows across the apps your employees use each day.
Connectivity with your tech stack supports the way you work, with data automatically updated where it's needed on-demand.
Example:
Building a custom integration or connector between Culture Amp and an your HRIS to enable the automated retrieval of recent manager review feedback that is loaded against each employee's profile within the HRIS, allowing your Managers to review this information more conveniently.
API Use Case Commonly Enabled via:
OKR (Objectives & Key Results), Project Tracking and Productivity Apps
Analytics tools
ATS (Application Tracking System) and HRIS (Human Resources Information System)
Coaching and Skills apps
Automating Tasks & Creating New Workflows
Automate low-value tasks to save time and refocus on your employee experience.
Develop your own custom workflows to support your organisation’s unique business needs. Automate tasks or workflows.
Example:
Setting up a custom workflow via Workato which takes a data change from the API as an input trigger to initiate a new workflow. For example, detecting a change in your employee’s Performance Ratings triggers a sequence to retrieve this data and update it in your employee's data stored in your data warehouse.
API Use Case Commonly Enabled via
iPaaS and Workflow Automators
OKR, Project Tracking and Productivity Apps
ATS and HRIS
Programmatic Data Management
Keep your data accurate and fresh everywhere it's needed automatically. Programmatically sync your people data and keep it updated seamlessly across your tech stack.
Example:
Automated data pulls daily to retrieve your Culture Amp Employee and Performance data, subsequently loading it to your Data Warehouse before distributing this to your other apps such as Greenhouse (ATS) where it is required automatically.
API Use Case Commonly Enabled via
OKR, Project Tracking and Productivity Apps
ATS and HRIS
Databases, Data Warehouses and Data Lakes
Do I need a Developer to use the API?
Yes. Using the API is highly technical and support from a developer is needed. It may also require data engineers or analysts to support managing, analysing and interpreting data obtain from the API.
What data is available via the API?
For the most up-to-date list of available data objects from the API, please refer to our API Reference Documentation.
Can I access historical data through the API?
Historic data availability varies by domain. Some domains are current-state and do not support historic data (for example, Employee Data). Others may enable up to several years of historic data to be accessed.
How often is data in the API updated?
The frequency of updates to data in the API vary by domain. Batch updates are made either within minutes or hours.
Are there additional costs involved in accessing the API?
No. Access to the API is included as part of your normal Culture Amp subscription fees and is not charged as an add-on.
How do I set up the API and use it?
To set up the API you need Administrator rights within your Culture Amp account.
Open your Settings page.
Click on the API tab via the left-hand side menu.
Follow the prompts to create an API credential.
Once you have produced a Client ID and Client Secret, note these somewhere safe. Never share your credentials or post them publicly.
To use the API:
Provide your credentials to a trusted developer within your organisation
The developer will need to Authenticate with the API. Details on how to do this can be found in the API Developer Portal.
They will then need to generate an access token prior to making calls with Authorisation Scopes included.
The developer will then use a valid access token to make requests against the endpoints of the API which are listed in our Reference Documentation.
Further instructions here.
Is the API paginated?
Yes the API supports paginated responses for some endpoints. For more details please refer to Pagination.
Does the API use rate limits or throttles?
Yes the API is rate limited. The limits are generous and shouldn’t affect normal use of the API. For more details please refer to your Developer Portal on Usage Limits.
Is there a sandbox environment for the API?
Sandbox endpoints and credential generation methods are coming soon.
Can I share my API credentials with others?
Never share your credentials or post them publicly. This includes sharing them with Culture Amp support.
I ran into an error - where can I get help?
Check the Developer Portal which has guidance on handling errors and troubleshooting error responses. If you can’t resolve your issue or believe it is due to a technical error, please reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.
I have feedback or a feature request - where can I submit it?
If you have feedback on the API, want to share your experiences in using it or are looking to request a new feature, you can submit your feedback here.
Can I ingest data via the API?
This functionality isn’t supported by the API at this time.