TeamRetro API
Getting started with the TeamRetro API
Configuring the TeamRetro API is currently only included on the Enterprise account.
This can only be configured by the Account Owner on an Enterprise plan.
What can be done with the API?
Using the API you can:
- manage users
- manage teams
- manage team memberships
- manage actions
- manage agreements
- view health models
- view retrospective metadata
- view health check metadata
- download CSV reports, including:
- team activity
- team action activity
- retrospective activity
- health check activity
- team health
- users
How to create an API key?
To create an API key, log in as the account owner and click on SETTINGS —> API & SCIM.
- Read through TeamRetro API Documentation as needed, then CREATE API KEY.
- Choose the scope to be covered by the API (i.e. Read, Write & SCIM) and click on CREATE.
- SAVE CHANGES when completed. You can REVOKE API KEY as needed.
