# Appfire Custom Fields API

**Canonical:** https://apis.io/apis/appfire/appfire-custom-fields-api/  
**Provider:** Appfire — https://apis.io/providers/appfire/  
**Base URL:** https://api.bigpicture.one/public/bigpicture/rest  
**Documentation:** https://developer.bigpicture.one/reference/whatisbigpicture

Appfire Custom Fields API is one of 77 APIs that [Appfire](https://apis.io/providers/appfire/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification.

Manage custom field definitions for Objectives and Key Results. Custom fields allow workspace administrators to attach additional structured data to OKRs — for example a "Risk level" dropdown, a "Budget" number field, or a "Owner" user picker. **Lifecycle** 1. Create a definition (`POST /api/v2/customField`) — this makes the field available in the UI for that field type. 2. Assign a value to an Objective or KR by including `customFieldValues` in the body of `PATCH /api/v2/okr/{id}` or `PATCH /api/v2/kr/{id}`. 3. Read values back via `GET /api/v2/okr/{id}` — the `customFieldValues` map in the response is keyed by field definition ID. **Permissions** — most write operations require the `MANAGE_CUSTOM_FIELDS` app permission (Jira admin role within the OKR app). Read operations require OKR view access.

## Operations (8)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v2/customField` | List visible custom field definitions |
| POST | `/api/v2/customField` | Create a new custom field definition |
| GET | `/api/v2/customField/{id}` | Get a custom field definition by ID |
| DELETE | `/api/v2/customField/{id}` | Soft-delete a custom field definition |
| PATCH | `/api/v2/customField/{id}` | Update a custom field definition |
| PATCH | `/api/v2/customField/{id}/visibility` | Show or hide a custom field definition |
| GET | `/api/v2/customField/{id}/options/usage` | Get usage count for a custom field option |
| GET | `/api/v2/customField/all` | List all custom field definitions including hidden |

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/appfire/refs/heads/main/openapi/appfire-custom-fields-api-openapi.yml

## Other Appfire APIs (12)

- [BigPicture Cloud Public API](https://apis.io/apis/appfire/bigpicture-cloud-public-api/)
- [Appfire API query methods API](https://apis.io/apis/appfire/appfire-api-query-methods-api/)
- [Appfire API update methods API](https://apis.io/apis/appfire/appfire-api-update-methods-api/)
- [Appfire Settings API](https://apis.io/apis/appfire/appfire-settings-api/)
- [Appfire Worklogs API](https://apis.io/apis/appfire/appfire-worklogs-api/)
- [Appfire Activity Resource API](https://apis.io/apis/appfire/appfire-activity-resource-api/)
- [Appfire Addon Descriptor Controller API](https://apis.io/apis/appfire/appfire-addon-descriptor-controller-api/)
- [Appfire AI Resource API](https://apis.io/apis/appfire/appfire-ai-resource-api/)
- [Appfire AI Settings Resource API](https://apis.io/apis/appfire/appfire-ai-settings-resource-api/)
- [Appfire Aikr Resource API](https://apis.io/apis/appfire/appfire-aikr-resource-api/)
- [Appfire Alignment Resource API](https://apis.io/apis/appfire/appfire-alignment-resource-api/)
- [Appfire API Token Resource API](https://apis.io/apis/appfire/appfire-api-token-resource-api/)

## Tags

Custom Fields

---

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