API

For users with instance administrator permission.

The Scorecard API enables you to connect other applications to the Clear Impact system. 

By using an API call, you can interact with scorecards, results and programs, indicators and performance measures, actions, tags, users, and imported and exported data values.


Note: If you’re not well-versed in API calls, you’ll likely need to enlist the skills of a web developer or programmer.

 

An API key is needed for connections between applications. To view your current API key, or generate a new one, click the Administration icon at the top, and choose API



Your current key is listed at the top. If needed, you can click Generate New / Remove API Key at the top. Note that this will delete your existing key, and any API calls that use the previous key will be rejected. You can also remove all API access by checking the Delete API Key checkbox.