WorkBoard
Strategic planning and goal management platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://www.myworkboard.com/wb/apis | link | — | — | — |
Actions (78)
Goals · 18
- Add commentPOST /goals/{goal_id}/comments
Add a comment to a goal.
documented - Create goalPOST /goals
Create a new objective/OKR.
documented - Create key resultPOST /goals/{goal_id}/key_results
Create a new key result under a goal.
documented - Delete commentDELETE /goals/{goal_id}/comments/{comment_id}
Remove a comment.
documented - Delete goalDELETE /goals/{goal_id}
Remove a goal.
documented - Delete key resultDELETE /goals/{goal_id}/key_results/{key_result_id}
Remove a key result.
documented - Get commentGET /goals/{goal_id}/comments/{comment_id}
Retrieve a specific comment on a goal.
documented - Get goalGET /goals/{goal_id}
Retrieve details for a specific goal.
documented - Get key resultGET /goals/{goal_id}/key_results/{key_result_id}
Retrieve a key result.
documented - List commentsGET /goals/{goal_id}/comments
Retrieve comments on a goal.
documented - List goalsGET /goals
Retrieve a list of goals in the organization.
documented - List key resultsGET /goals/{goal_id}/key_results
Retrieve all key results for a given goal.
documented - Partial update commentPATCH /goals/{goal_id}/comments/{comment_id}
Update parts of a comment.
documented - Partial update goalPATCH /goals/{goal_id}
Update parts of a goal.
documented - Partial update key resultPATCH /goals/{goal_id}/key_results/{key_result_id}
Update parts of a key result.
documented - Update commentPUT /goals/{goal_id}/comments/{comment_id}
Replace a comment.
documented - Update goalPUT /goals/{goal_id}
Replace a goal's details.
documented - Update key resultPUT /goals/{goal_id}/key_results/{key_result_id}
Replace a key result.
documented
Metrics · 12
- Create data pointPOST /metrics/{metric_id}/data_points
Add a data point to a metric.
documented - Create metricPOST /metrics
Create a new metric.
documented - Delete data pointDELETE /metrics/{metric_id}/data_points/{data_point_id}
Remove a data point.
documented - Delete metricDELETE /metrics/{metric_id}
Remove a metric.
documented - Get data pointGET /metrics/{metric_id}/data_points/{data_point_id}
Retrieve a data point for a metric.
documented - Get metricGET /metrics/{metric_id}
Retrieve a metric.
documented - List data pointsGET /metrics/{metric_id}/data_points
Retrieve data points for a metric.
documented - List metricsGET /metrics
Retrieve defined metrics in the system.
documented - Partial update data pointPATCH /metrics/{metric_id}/data_points/{data_point_id}
Update parts of a data point.
documented - Partial update metricPATCH /metrics/{metric_id}
Update parts of a metric.
documented - Update data pointPUT /metrics/{metric_id}/data_points/{data_point_id}
Replace a data point.
documented - Update metricPUT /metrics/{metric_id}
Replace a metric.
documented
Workstreams · 12
- Create workstreamPOST /workstreams
Create a new workstream.
documented - Create workstream taskPOST /workstreams/{workstream_id}/tasks
Create a new task within a workstream.
documented - Delete workstreamDELETE /workstreams/{workstream_id}
Remove a workstream.
documented - Delete workstream taskDELETE /workstreams/{workstream_id}/tasks/{task_id}
Remove a workstream task.
documented - Get workstreamGET /workstreams/{workstream_id}
Retrieve a specific workstream.
documented - Get workstream taskGET /workstreams/{workstream_id}/tasks/{task_id}
Retrieve a task in a workstream.
documented - List workstream tasksGET /workstreams/{workstream_id}/tasks
Retrieve tasks within a workstream.
documented - List workstreamsGET /workstreams
Retrieve workstreams in the organization.
documented - Partial update workstreamPATCH /workstreams/{workstream_id}
Update parts of a workstream.
documented - Partial update workstream taskPATCH /workstreams/{workstream_id}/tasks/{task_id}
Update parts of a workstream task.
documented - Update workstreamPUT /workstreams/{workstream_id}
Replace a workstream.
documented - Update workstream taskPUT /workstreams/{workstream_id}/tasks/{task_id}
Replace a workstream task.
documented
Action Items · 6
- Create action itemPOST /action_items
Create a new action item.
documented - Delete action itemDELETE /action_items/{action_item_id}
Remove an action item.
documented - Get action itemGET /action_items/{action_item_id}
Retrieve a specific action item.
documented - List action itemsGET /action_items
Retrieve action items.
documented - Partial update action itemPATCH /action_items/{action_item_id}
Update parts of an action item.
documented - Update action itemPUT /action_items/{action_item_id}
Replace an action item.
documented
Data Streams · 6
- Create data streamPOST /data_streams
Create a new data stream.
documented - Delete data streamDELETE /data_streams/{data_stream_id}
Remove a data stream.
documented - Get data streamGET /data_streams/{data_stream_id}
Retrieve a data stream.
documented - List data streamsGET /data_streams
Retrieve data streams.
documented - Partial update data streamPATCH /data_streams/{data_stream_id}
Update parts of a data stream.
documented - Update data streamPUT /data_streams/{data_stream_id}
Replace a data stream.
documented
Tags · 6
- Create tagPOST /tags
Create a new tag.
documented - Delete tagDELETE /tags/{tag_id}
Remove a tag.
documented - Get tagGET /tags/{tag_id}
Retrieve a specific tag.
documented - List tagsGET /tags
Retrieve tags.
documented - Partial update tagPATCH /tags/{tag_id}
Update parts of a tag.
documented - Update tagPUT /tags/{tag_id}
Replace a tag.
documented
Teams · 6
- Create teamPOST /teams
Create a new team.
documented - Delete teamDELETE /teams/{team_id}
Remove a team.
documented - Get teamGET /teams/{team_id}
Retrieve a specific team.
documented - List teamsGET /teams
Retrieve teams in the organization.
documented - Partial update teamPATCH /teams/{team_id}
Update parts of a team.
documented - Update teamPUT /teams/{team_id}
Replace a team.
documented
Users · 6
- Create userPOST /users
Create a new user in the organization.
documented - Delete userDELETE /users/{user_id}
Remove a user from the organization.
documented - Get userGET /users/{user_id}
Retrieve details for a specific user.
documented - List usersGET /users
Retrieve a list of users in the organization.
documented - Partial update userPATCH /users/{user_id}
Update parts of a user's details.
documented - Update userPUT /users/{user_id}
Replace a user's details.
documented
Webhooks · 6
- Create webhookPOST /webhooks
Create a new webhook.
documented - Delete webhookDELETE /webhooks/{webhook_id}
Remove a webhook.
documented - Get webhookGET /webhooks/{webhook_id}
Retrieve a webhook.
documented - List webhooksGET /webhooks
Retrieve webhooks for the account.
documented - Partial update webhookPATCH /webhooks/{webhook_id}
Update parts of a webhook.
documented - Update webhookPUT /webhooks/{webhook_id}
Replace a webhook.
documented