The ClearPoint API allows you to integrate ClearPoint with other applications and data sources—improving data accuracy, ensuring consistency, and enabling better decision-making across your organization.

Get Your API Keys

Before you can use the API, you must generate your personal API Keys.
API Keys are available on Enterprise plans and can be created in System Settings.

For instructions on generating and managing API Keys, see:
Getting and Using ClearPoint API Keys.

Learn Key ClearPoint Concepts

Understanding a few ClearPoint data concepts will make API usage much easier.

Edit Fields vs. Update Fields

ClearPoint is a performance reporting tool designed for periodic updates (monthly, quarterly, annually).

Some fields stay consistent over time; others change every reporting period.

Edit Fields
- Do not change per reporting period
- Examples: Name, Owner, Definition
Update Fields
- Hold values specific to each reporting period
- Examples: Status, Analysis, Measure Data

💡 Knowing which type of field you are interacting with determines whether API updates use edits or updates in your payload.

Scorecards

A Scorecard functions like a folder that organizes your reporting structure.
Objectives, Measures, Initiatives, and other elements live inside Scorecards and may also appear in multiple Scorecards via linking.

💡 You must have access to a Scorecard where an element lives in order to access that element via the API.

Default Element Names

ClearPoint’s default reporting elements are:

Scorecard
Category
Objective
Measure
Initiative
Milestone
Action Item
Risk

Your organization may customize element names in the UI. However, the API always uses default names.

To match your organization’s terminology to ClearPoint’s default element names, see:
this help center article.

💡 Not all organizations use all element types; unused ones may be hidden in your account.

Get Familiar with the ClearPoint API Structure

ClearPoint’s API Documentation is organized by element (e.g., Objectives).
Each section lists available endpoints and methods for that element.

The documentation is not intended to act as a user interface—it’s a guide that helps you understand which calls are available and how to structure them.

Helpful Tip

Use your browser’s Developer Tools while logged into ClearPoint.
Make a change in the app, then inspect the Network tab to see:

The API endpoint
The request type
The payload format

This is one of the easiest ways to learn how to structure your own calls.

REST Methods the ClearPoint API Supports

ClearPoint’s API exposes the four standard REST methods:

POST — Create
GET — Read
PUT — Update/Replace
DELETE — Delete

Example:

Retrieve all Scorecards you have access to:

GET /scorecards

Retrieve a specific Scorecard:

GET /scorecards/{scorecardId}

Request & Response Format

All requests use HTTPS
All payloads must be JSON
All responses are returned in JSON

Practice Common API Calls

For testing API calls, we recommend using Postman.
You can safely explore calls using the demo server. The demo database resets nightly at 1 AM based on the current production data.

When you're ready, switch to the production URL.

Try these common calls using your API Keys in the request headers:

1. Get all Scorecards

GET /scorecards

2. Get a specific Scorecard

GET /scorecards/{scorecardId}

3. Create a Measure

POST /measures

Be sure to include the scorecardId and a name in the request body.

4. Retrieve a Measure

GET /measures/{measureId}

Record the seriesId for one of the measure’s series.

5. Get Reporting Periods

GET /periods

Record the periodId.

Updating Data with the API

The POST /update call is the primary method for making changes to your ClearPoint data.

It can modify edit fields, add new measure data, and update fields for a specific reporting period.

Below is an example payload that:

Updates the measure’s name
Adds a new data point to a measure series
Updates the analysis field for a reporting period

{
  "edits": [
    {
      "object": "measure",
      "objectId": {objectId},
      "fields": {
        "name": "<Insert name change here>",
        "measureData": [
          {
            "periodId": {periodId},
            "series{seriesId}": <Insert a numeric value>
          }
        ]
      }
    }
  ],
  "updates": [
    {
      "object": "measure",
      "objectId": {objectId},
      "periodId": {periodId},
      "fields": {
        "analysis": "<Insert sample analysis here>"
      }
    }
  ]
}