TeamRetro API
Getting started with the TeamRetro API
The TeamRetro API is available on all plans. What differs is the level at which you can create an API key, and therefore the data that key can access.
Team API key: Available on all plans, including Large Organization. Created from that team's settings, and restricted to read and write access for that team's data only.
Account API key: Available on Enterprise plans only. Created by the Account Owner from account settings, and provides access to data across all teams in the account.
What can be done with the API?
NOTE: Team API keys must be enabled on your account in order to be used.
If you don't see this option, ask an Account Owner or Account Administrator to enable Team API Keys under SETTINGS —> API & Connected Apps.
| Capability | Account API key | Team API key |
|---|---|---|
| Manage users | All users | — |
| Manage teams | All teams | That team only |
| Manage team memberships | All teams | That team only |
| Manage actions | All teams | That team only |
| Manage agreements | All teams | That team only |
| View health models | Yes | Yes |
| View retrospective metadata | All teams | That team only |
| View health check metadata | All teams | That team only |
| CSV reports |
|
|
| Team activity | All teams | That team only |
| Team action activity | All teams | That team only |
| Retrospective activity | All teams | That team only |
| Health check activity | All teams | That team only |
| Team health | All teams | That team only |
| Users | Yes | — |
How to create an API key?
Creating a Team API key (All plans)
-
To create a team API key, log in as the Team Admin or Account Owner and click on SETTINGS —> API
-
Read through the TeamRetro API Documentation as needed, then CREATE TEAM API KEY.
-
Choose the scope to be covered by the key (Read and/or Write) and click CREATE.
- Your API key will be created and will appear. In future, you can REVOKE API KEY as needed.
Creating an Account API key (Enterprise Only)
-
To create an account-wide API key, log in as the Account Owner and click on SETTINGS —> API & CONNECTED APPS.
-
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.
- Your API key will be created and will appear. In future, you can REVOKE API KEY as needed.
Looking to manage user accounts? TeamRetro also supports SCIM.