How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
WorkBoard

WorkBoard Custom Attributes API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 2.0.

Requests are made against a single base URL, https://www.myworkboard.com/wb/apis/v2.

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.2.0
API Version
2.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) (bearer).

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), InvalidCustomAttributeValueErrorResponse (5 properties), ApiErrorResponse (5 properties). Each schema is shown below with its type and property counts.

InvalidCustomAttributeValueErrorResponse
object
5 properties 4 required
AttributeObject
object
8 properties 3 required
SetAttributeResponse
object
1 property 1 required
AttributeObjectsResponse
object
4 properties 4 required
AttributeObjectsPagination
object
3 properties 3 required
ObjectCustomAttributesResponse
object
3 properties 3 required
InvalidCustomAttributeValueErrorDetails
object
1 property 1 required
OrgDefinitionsResponse
object
1 property 1 required
CustomAttributeDefinition
object
6 properties 5 required
SetAttributeValue
object
1 property 1 required
ApiErrorDetails
object
3 properties
ApiErrorResponse
object
5 properties 4 required
CustomAttributeValue
object
5 properties 3 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
AE Profile APIs.io
WorkBoard Activity (Action Items) API
AE Profile APIs.io
WorkBoard Goal (Objective) 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
WorkBoard Data Stream API
AE Profile APIs.io
#Custom Attributes
← Back to W APIs
API Details
ID
workboard:workboard-custom-attributes-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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=workboard-custom-attributes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/workboard-custom-attributes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of WorkBoard Custom Attributes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.