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

WorkBoard custom-attributes API

Read and write custom field values on Objectives, Key Results, Work Items, and Users

WorkBoard custom-attributes API is one of 12 APIs that WorkBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include custom-attributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a changelog.

This API exposes 18 operations across 10 paths, and defines 13 schemas. 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.

18 operations 10 paths 13 schemas 4 DELETE6 GET4 POST4 PUT

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 custom-attributes 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 18

Across 10 paths, the API surfaces 18 operations — 4 DELETE, 6 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

custom-attributes 18

Read and write custom field values on Objectives, Key Results, Work Items, and Users

GET
/attributes/definitions
List custom field definitions for the org
CustomAttributesController_getDefinitions 1 param → 200400401500
GET
/attributes/{attributeId}/objects
List every object that has a value for a custom attribute
CustomAttributesController_getObjectsForAttribute 3 params → 200400401404500
GET
/attributes/objectives/{id}
Get custom attribute values for an Objective
CustomAttributesController_getObjectiveAttributes 3 params → 200401404500
POST
/attributes/objectives/{id}/{attributeId}
Create (set) a custom attribute value on an Objective
CustomAttributesController_createObjectiveAttributeValue 2 params body → 200400401403404500
PUT
/attributes/objectives/{id}/{attributeId}
Update a custom attribute value on an Objective
CustomAttributesController_setObjectiveAttributeValue 2 params body → 200400401403404500
DELETE
/attributes/objectives/{id}/{attributeId}
Clear a custom attribute value from an Objective
CustomAttributesController_deleteObjectiveAttributeValue 2 params → 204401403404500
GET
/attributes/key-results/{id}
Get custom attribute values for a Key Result
CustomAttributesController_getKeyResultAttributes 3 params → 200401404500
POST
/attributes/key-results/{id}/{attributeId}
Create (set) a custom attribute value on a Key Result
CustomAttributesController_createKeyResultAttributeValue 2 params body → 200400401403404500
PUT
/attributes/key-results/{id}/{attributeId}
Update a custom attribute value on a Key Result
CustomAttributesController_setKeyResultAttributeValue 2 params body → 200400401403404500
DELETE
/attributes/key-results/{id}/{attributeId}
Clear a custom attribute value from a Key Result
CustomAttributesController_deleteKeyResultAttributeValue 2 params → 204401403404500
GET
/attributes/work-items/{id}
Get custom attribute values for a Work Item
CustomAttributesController_getWorkItemAttributes 3 params → 200401404500
POST
/attributes/work-items/{id}/{attributeId}
Create (set) a custom attribute value on a Work Item
CustomAttributesController_createWorkItemAttributeValue 2 params body → 200400401404500
PUT
/attributes/work-items/{id}/{attributeId}
Update a custom attribute value on a Work Item
CustomAttributesController_setWorkItemAttributeValue 2 params body → 200400401404500
DELETE
/attributes/work-items/{id}/{attributeId}
Clear a custom attribute value from a Work Item
CustomAttributesController_deleteWorkItemAttributeValue 2 params → 204401404500
GET
/attributes/users/{id}
Get custom attribute values for a User
CustomAttributesController_getUserAttributes 3 params → 200401403404500
POST
/attributes/users/{id}/{attributeId}
Create (set) a custom attribute value on a User
CustomAttributesController_createUserAttributeValue 2 params body → 200400401403404500
PUT
/attributes/users/{id}/{attributeId}
Update a custom attribute value on a User
CustomAttributesController_setUserAttributeValue 2 params body → 200400401403404500
DELETE
/attributes/users/{id}/{attributeId}
Clear a custom attribute value from a User
CustomAttributesController_deleteUserAttributeValue 2 params → 204401403404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are AttributeObject (8 properties), CustomAttributeDefinition (6 properties), ApiErrorResponse (5 properties), CustomAttributeValue (5 properties). Each schema is shown below with its type and property counts.

AttributeObjectsResponse
object
4 properties 4 required
ApiErrorResponse
object
5 properties 4 required
SetAttributeResponse
object
1 property 1 required
ObjectCustomAttributesResponse
object
3 properties 3 required
CustomAttributeValue
object
5 properties 3 required
ApiErrorDetails
object
3 properties
OrgDefinitionsResponse
object
1 property 1 required
AttributeObject
object
8 properties 3 required
InvalidCustomAttributeValueErrorResponse
object
5 properties 4 required
AttributeObjectsPagination
object
3 properties 3 required
CustomAttributeDefinition
object
6 properties 5 required
InvalidCustomAttributeValueErrorDetails
object
1 property 1 required
SetAttributeValue
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

workboard-custom-attributes-api-openapi.yml Raw ↑

Other APIs WorkBoard publishes across the network.

WorkBoard SCIM API
WorkBoard Activity (Action Items) API
WorkBoard Datastream API
WorkBoard Goal (Objective) API
WorkBoard Metric (Key Result) API
WorkBoard Tags API
WorkBoard Team API
WorkBoard User API
WorkBoard User Goals (User Objectives) API
WorkBoard Webhook API
WorkBoard Workstream API