Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

WorkBoard

WorkBoard Goal (Objective) API

The Goal (Objective) API from WorkBoard — 5 operation(s) for goal (objective).

Documentation Provider Profile APIs.io OpenAPI GitHub

WorkBoard Goal (Objective) API is one of 12 APIs that WorkBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Goal (Objective). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a changelog.

This API exposes 6 operations across 5 paths. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://demo.biz.wobo-int.com/wb/apis.

6 operations 5 paths 0 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://www.myworkboard.com/wb/apis
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

WorkBoard Goal (Objective) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearerAuth — JWT Authorization header using the Bearer scheme.

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Goal (Objective) 6
GET
/goal
Get Goals using parameters to filter results.
9 params → 200400
POST
/goal
Create a goal for a user in your organization, including metrics sourced from the same person. Make sure you have Data-Admin permission for your access token.
body → 200400
GET
/goal/{goal_id_path}
Get Goals using parameters to filter results.
3 params → 200400
GET
/goal/{goal_id_path}/metric/{metric_id_path}
List data for one metric (specified by the metricid parameter) associated with the goal specified by the goalid parameter.
2 params → 200400
GET
/goal/{goal_id_path}/pillars
Get a Goal's associated strategies and pillars from WorkBoard Strategy. Note, the logged in user must have Data-Admin permission and have access to WorkBoard Strategy in order to view the goal pillar…
1 param → 200400
GET
/goal/{goal_id_path}/alignment
List aligned and dependent goals associated with the goal specified by the goalid parameter. Note, the logged in user must have Data-Admin permission in order to view the goal alignment.
1 param → 200400

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workboard-goal-objective-api-openapi.yml Raw ↑

Other APIs WorkBoard publishes across the network.

WorkBoard SCIM API
AE Profile APIs.io
WorkBoard Activity (Action Items) API
AE Profile APIs.io
WorkBoard custom-attributes API
AE Profile APIs.io
WorkBoard Datastream API
AE Profile APIs.io
WorkBoard Metric (Key Result) API
AE Profile APIs.io
WorkBoard Tags API
AE Profile APIs.io
WorkBoard Team API
AE Profile APIs.io
WorkBoard User API
AE Profile APIs.io
WorkBoard User Goals (User Objectives) API
AE Profile APIs.io
WorkBoard Webhook API
AE Profile APIs.io
WorkBoard Workstream API
AE Profile APIs.io
#Goal (Objective)
← Back to W APIs
API Details
ID
workboard:workboard-goal-objective-api
Base URL
https://www.myworkboard.com/wb/apis
Docs
https://apidocs.myworkboard.com/
Provider
WorkBoard
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network