Jump to Content
App Login
Support Center
Product Updates
OAS JSON
Guides
Recipes
API Reference
v16
App Login
Support Center
Product Updates
OAS JSON
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
July 2024
Guides
Recipes
API Reference
List periods
Search
All
Pages
Start typing to search…
JUMP TO
ClearPoint Strategy API
Elements
Scorecards
List scorecards
get
Create scorecard
post
Delete scorecard
delete
Get scorecard
get
Edit scorecard
put
Get scorecard language
get
Get scorecard measure data
get
Get scorecard menu
get
Scorecard Status
Get scorecard status
get
Update scorecard status
put
Collections
List scorecard action items
get
List scorecard charts
get
List scorecard custom fields
get
List scorecard initiatives
get
List scorecard measures
get
List scorecard milestones
get
List scorecard objectives
get
List scorecard risks
get
Categories
Delete category
delete
Get category
get
Edit category
put
List category links
get
List categories
get
Create category
post
Objectives
List objectives
get
Create objective
post
Delete objective
delete
Get objective
get
Edit objective
put
Get objective custom fields
get
Get objective evaluations
get
Get objective links
get
Get objective reference series
get
Objective Status
Get objective status
get
Update objective status
put
Measures
List measures
get
Create measure
post
Delete measure
delete
Get measure
get
Edit measure
put
Get measure custom fields
get
Get measure links
get
Measure Series
Delete measure series
delete
Get measure series
get
Edit measure series
put
Get series calculation map
get
List measure series
get
Create measure series
post
Get measure reference series
get
Measure Data
Get measure data
get
Update measure data
post
Get grid measure data
get
Get measure periods
get
Recalculate measure
post
Measure Status
Get measure status
get
Update measure status
put
Charts
Delete chart
delete
Get chart
get
Edit chart
put
List embedded charts
get
List charts
get
Create chart
post
Initiatives
List initiatives
get
Create initiative
post
Delete initiative
delete
Get initiative
get
Edit initiative
put
Get initiative custom fields
get
Get initiative Gantt
get
Get initiative links
get
Get initiative reference series
get
Initiative Status
Get initiative status
get
Update initiative status
put
Milestones
List milestones
get
Create milestone
post
Delete milestone
delete
Get milestone
get
Edit milestone
put
Get milestone custom fields
get
Get milestone links
get
Get milestone reference series
get
Milestone Status
Get milestone status
get
Update milestone status
put
Action Items
List action items
get
Create action item
post
Delete action item
delete
Get action item
get
Edit action item
put
Get action item custom fields
get
Get action item links
get
Get action item reference series
get
Action Item Status
Get action item status
get
Update action item status
put
Risks
List risks
get
Create risk
post
Delete risk
delete
Get risk
get
Edit risk
put
Get risk custom fields
get
Get risk links
get
Get risk reference series
get
Risk Status
Get risk status
get
Update risk status
put
Goals
List goals
get
Create goal
post
Delete goal
delete
Get goal
get
Edit goal
put
Get goal custom fields
get
Get goal links
get
Key Results
List key results
get
Create key result
post
Delete key result
delete
Get key result
get
Edit key result
put
Element Fields
Bulk edit elements
post
Get element
get
Get scorecard fields
get
Get objective fields
get
Get measure fields
get
Get initiative fields
get
Get milestone fields
get
Get actionitem fields
get
Get risk fields
get
Get field history
get
Personalization
Views
List views
get
Create view
post
Delete view
delete
Get view
get
Import / export view
post
Edit view
put
Workspaces
List Workspaces
get
Create Workspace
post
Delete Workspace
delete
Get Workspace
get
Edit Workspace
put
My ClearPoint
Get My Mentions
get
Get My Profile
get
Get My Favorites
get
Get My Scorecard
get
Get My Updates
get
Get My Edits
get
My Favorites
Check favorite
get
Toggle favorite
post
Collaboration
Comments and Mentions
List comments
get
Add comment
post
Delete comment
delete
Get comment
get
Edit comment
put
Toggle mention status
put
Approvals
List My Approvals
get
Get approval
get
Edit approval
put
Workflows
List workflows
get
Create workflow
post
Delete workflow
delete
Get workflow
get
Edit task completion
post
Edit workflow
put
Send workflow reminder
post
Get workflow status
get
Complete Workflow Task
post
Workflow Emails
Delete workflow email
delete
Get workflow email
get
Sends a workflow email
post
Edit workflow email
put
List workflow emails
get
Create workflow email
post
Peer Sharing
List peer groups
get
Get peer group members
get
List peer group measures
get
Get peer measure
get
Add peer measure
post
Get peer measure data
get
Get peer measure series
get
Get peer measure preview
get
Reporting
Templates
List templates
get
Create template
post
Delete template
delete
Get template
get
Edit template
put
Reports
List reports
get
Create report
post
Delete report
delete
Get report
get
Edit report
post
Edit report
put
Summary Reports
Get report columns
get
Get summary report columns
get
List summary reports
get
Create summary report
post
Delete summary report
delete
Get summary report
get
Edit summary report
put
Get summary report elements
get
Get matching elements
get
Scorecard Reports
List scorecard reports
get
Create scorecard report
post
Delete scorecard report
delete
Get scorecard report
get
Edit scorecard report
put
Get scorecard report elements
get
Get layout elements
get
Maps
Create map
post
Delete map
delete
Get map
get
Edit map
put
List scorecard maps
get
Detail Pages
Get detail layout
get
Edit detail layout
post
Get print detail layout
put
List detail page pods
get
Files
Files
List files
get
Create file
post
Delete file
delete
Get file
get
Upload file
post
Attachments
List attachments
get
Create attachment
post
Delete attachment
delete
Get attachment
get
Edit attachment
put
Images
List images
get
Upload image
post
Delete image
delete
Exports
List exported pages
get
Delete exported page
post
Delete export
delete
Get page export
get
Edit page export
put
Automation
Schedules
Get next schedules
get
Get scheduled packages
get
List schedules
get
Create schedule
post
Delete schedule
delete
Get schedule
get
Create schedule
post
Edit schedule
put
Scripting
List scripts
get
Create script
post
Delete script
delete
Get script
get
Edit script
put
Bulk edit elements
post
Integrations
List integrations
get
Create integration
post
Delete integration
delete
Get integration
get
Run integration
post
Edit integration
put
Webhooks
List webhooks
get
Create webhook
post
Delete webhook
delete
Get webhook
get
Edit webhook
put
REST Hooks
List linked elements
get
List subscriptions
get
Create subscription
post
Delete subscription
delete
Alerts
List alerts
get
Delete alert
delete
Get alert
get
Edit alert
put
Notifications
List notifications
get
Create notification
post
Delete notification
delete
Get notification
get
Edit notification
put
List notifications
get
Reminders
List reminders
get
Create / preview reminder
post
Delete reminder
delete
Get / send reminder
get
Edit reminder
put
Customization
Status
List status
get
Create status
post
Delete status
delete
Get status
get
Edit status
put
Reporting Periods
List periods
get
Create period
post
Delete period
delete
Get period
get
Edit period
put
Reporting Frequencies
List reporting frequencies
get
Create reporting frequency
post
Delete reporting frequency
delete
Get reporting frequency
get
Edit reporting frequency
put
Fiscal Years
List fiscal years
get
Create fiscal year
post
Delete fiscal year
delete
Get fiscal year
get
Edit fiscal year
put
Master Periods
List master periods
get
Update master periods
post
Default Series
List default series
get
Create default series
post
Delete default series type
delete
Get default series
get
Edit default series
put
Report Styles
List report styles
get
Create report styles
post
Delete report style
delete
Get report style
get
Edit report style
put
Table Styles
List table styles
get
Create table style
post
Delete table style
delete
Get table style
get
Edit table style
put
Pod Styles
List pod styles
get
Create pod style
post
Delete pod style
delete
Get pod style
get
Edit pod style
put
Tags
List tags
get
Create tag
post
Delete tag
delete
Get tag
get
Edit tag
put
List tagged elements
get
Chart Formats
List chart JSON formats
get
List custom chart types
get
Create custom chart type
post
Delete custom chart type
delete
Get custom chart type
get
Edit custom chart type
put
Number Formats
List number formats
get
Create number format
post
Delete number format
delete
Get number format
get
Edit number format
put
Calculated Fields
List calculated fields
get
Create calculated field
post
Delete calculated field
delete
Get calculated field
get
Edit calculated field
put
Custom Fields
List custom fields
get
Create custom field
post
Delete custom field
delete
Get custom field
get
Edit custom field
put
Fields and Element Names
List fields
get
Get fields
get
List labels
get
List menus
get
Edit menu
put
List reference series
get
Administration
Defaults
List chart types
get
Get chart type
get
List currencies
get
List default field labels
get
List locales
get
Get locale language
get
List series data types
get
Get series data type
get
Get user timezone
get
List timezones
get
Setup
Get account options
get
Update account options
post
API Keys
List API Keys
get
Create API Key
post
Delete API Key
delete
Get API Key
get
Edit API Key
put
Utilities
Empty recycle bin
post
Hard delete element
delete
List log entries
get
Get log file
get
Send email
post
Search
Filter elements
put
List filter fields
get
List matching elements
post
Snapshots
List snapshots
get
Create snapshot
post
Delete snapshot
delete
Get snapshot
get
Edit snapshot
put
Authentication
Login
post
Logout
post
Get password rules
get
Reset Password
post
Checks to see if the session is still valid.
get
SSO Login
post
Get 2FA codes
get
Create new 2FA codes
post
Validate IP address
post
User Groups
List groups
get
Create group
post
Delete group
delete
Get group
get
Edit group
put
Users
List scorecard users
get
Create scorecard user
post
List users
get
Create user
post
Delete user
delete
Get user
get
Edit user
put
Powered by
List periods
get
https://app.clearpointstrategy.com/api/v1/periods
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
OAuth2
Authenticate
Bearer
Log in to use your API keys
RESPONSE
Click
Try It!
to start a request and see the response here!
