> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.brightmove.com/public/custom-fields/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.brightmove.com/_mcp/server.

# Custom Fields API

Custom Fields (also called User-Defined Fields, or UDFs) let you get, set, and clear values for
fields your organization has added to an entity beyond BrightMove's standard schema. Every operation
is scoped by `entityTypeId`, the numeric identifier for the entity the field belongs to:

| `entityTypeId` | Entity              |
| :------------- | :------------------ |
| 1              | Applicant/Candidate |
| 2              | Contact/Manager     |
| 3              | Office/Location     |
| 4              | Client              |
| 5              | Job                 |
| 6              | Placement           |

> Custom Fields API operations.


## API Docs

- Core [Clear a custom field's value for an entity](https://docs.brightmove.com/public/custom-fields/core/clear-value.md)
- Core [Get custom field values for an entity](https://docs.brightmove.com/public/custom-fields/core/get-values.md)
- Core [List custom field definitions](https://docs.brightmove.com/public/custom-fields/core/get-definitions.md)
- Core [Set a custom field's value for an entity](https://docs.brightmove.com/public/custom-fields/core/set-value.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.brightmove.com/public/custom-fields/openapi.json)
- [OpenAPI YAML](https://docs.brightmove.com/public/custom-fields/openapi.yaml)