# WorkBoard custom-attributes API

**Canonical:** https://apis.io/apis/workboard/workboard-custom-attributes-api/  
**Provider:** WorkBoard — https://apis.io/providers/workboard/  
**Base URL:** https://www.myworkboard.com/wb/apis  
**Documentation:** https://apidocs.myworkboard.com/

WorkBoard custom-attributes API is one of 12 APIs that [WorkBoard](https://apis.io/providers/workboard/) publishes on the [APIs.io](https://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.

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

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/attributes/definitions` | List custom field definitions for the org |
| GET | `/attributes/{attributeId}/objects` | List every object that has a value for a custom attribute |
| GET | `/attributes/objectives/{id}` | Get custom attribute values for an Objective |
| POST | `/attributes/objectives/{id}/{attributeId}` | Create (set) a custom attribute value on an Objective |
| PUT | `/attributes/objectives/{id}/{attributeId}` | Update a custom attribute value on an Objective |
| DELETE | `/attributes/objectives/{id}/{attributeId}` | Clear a custom attribute value from an Objective |
| GET | `/attributes/key-results/{id}` | Get custom attribute values for a Key Result |
| POST | `/attributes/key-results/{id}/{attributeId}` | Create (set) a custom attribute value on a Key Result |
| PUT | `/attributes/key-results/{id}/{attributeId}` | Update a custom attribute value on a Key Result |
| DELETE | `/attributes/key-results/{id}/{attributeId}` | Clear a custom attribute value from a Key Result |
| GET | `/attributes/work-items/{id}` | Get custom attribute values for a Work Item |
| POST | `/attributes/work-items/{id}/{attributeId}` | Create (set) a custom attribute value on a Work Item |
| PUT | `/attributes/work-items/{id}/{attributeId}` | Update a custom attribute value on a Work Item |
| DELETE | `/attributes/work-items/{id}/{attributeId}` | Clear a custom attribute value from a Work Item |
| GET | `/attributes/users/{id}` | Get custom attribute values for a User |
| POST | `/attributes/users/{id}/{attributeId}` | Create (set) a custom attribute value on a User |
| PUT | `/attributes/users/{id}/{attributeId}` | Update a custom attribute value on a User |
| DELETE | `/attributes/users/{id}/{attributeId}` | Clear a custom attribute value from a User |

## Machine-readable artifacts (3)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/workboard/refs/heads/main/openapi/workboard-custom-attributes-api-openapi.yml
- **Documentation** — https://apidocs.myworkboard.com/
- **ChangeLog** — https://apidocs.myworkboard.com/changes.html

## Other WorkBoard APIs (11)

- [WorkBoard SCIM API](https://apis.io/apis/workboard/workboard-scim-api/)
- [WorkBoard Activity (Action Items) API](https://apis.io/apis/workboard/workboard-activity-action-items-api/)
- [WorkBoard Datastream API](https://apis.io/apis/workboard/workboard-datastream-api/)
- [WorkBoard Goal (Objective) API](https://apis.io/apis/workboard/workboard-goal-objective-api/)
- [WorkBoard Metric (Key Result) API](https://apis.io/apis/workboard/workboard-metric-key-result-api/)
- [WorkBoard Tags API](https://apis.io/apis/workboard/workboard-tags-api/)
- [WorkBoard Team API](https://apis.io/apis/workboard/workboard-team-api/)
- [WorkBoard User API](https://apis.io/apis/workboard/workboard-user-api/)
- [WorkBoard User Goals (User Objectives) API](https://apis.io/apis/workboard/workboard-user-goals-user-objectives-api/)
- [WorkBoard Webhook API](https://apis.io/apis/workboard/workboard-webhook-api/)
- [WorkBoard Workstream API](https://apis.io/apis/workboard/workboard-workstream-api/)

## Tags

Custom Attributes

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/workboard/workboard-custom-attributes-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/workboard/.