--- title: Work with custom fields description: Read and write to custom fields programmatically with the Casebook API --- [Skip to content](https://gohub.casebook.net/knowledge/work-with-custom-fields#main-content) [More support](https://gohub.casebook.net/knowledge/kb-tickets/new) [![logo-raspberry (1)](https://gohub.casebook.net/hs-fs/hubfs/logo-raspberry%20(1).png?width=1286&height=255&name=logo-raspberry%20(1).png)](https://gohub.casebook.net/) - [Knowledge Base](https://gohub.casebook.net/knowledge) - [Video Library](https://gohub.casebook.net/video-library) - [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new) Open main navigation Close main navigation - [Knowledge Base](https://gohub.casebook.net/knowledge) - [Video Library](https://gohub.casebook.net/video-library) - [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new) - [More support](https://gohub.casebook.net/knowledge/kb-tickets/new) Hi. How can we help? - There are no suggestions because the search field is empty. 1. [Knowledge Base](https://gohub.casebook.net/knowledge) 2. [Integrations](https://gohub.casebook.net/knowledge/integrations) 3. [Custom incoming integrations with Casebook API](https://gohub.casebook.net/knowledge/integrations#custom-incoming-integrations-with-casebook-api) # Work with custom fields ## Read and write to custom fields programmatically with the Casebook API ### Introduction In Casebook, custom fields can be created to augment Cases, Intake reports, and People with fields that are important to your organization that are not included in default fields. Custom fields can be configured to store text, a number, a date, a true or false Boolean, or a single-select dropdown value (enum). This guide provides instructions and code samples for reading from and writing to all types of custom fields in the Casebook API. ### Prerequisites **Your organization must be licensed for External Data Interoperability (API)** to interact with the Casebook API. **You will need to [register an incoming application](https://gohub.casebook.net/knowledge/register-an-incoming-application) and [obtain a Bearer token](https://gohub.casebook.net/knowledge/obtain-a-bearer-token)** before starting this guide. ### Instructions #### Fetch custom field values for a Case, Intake Report, or Person record Requests that return Cases, Intake Reports, or People will include a `custom_fields` attribute which lists all populated custom fields with their value.  If there is no value in any custom field on the record, then the value for the `custom_fields` attribute will be null or empty. For example, custom field values for Cases can be fetched using [Cases - Query all Cases](https://www.postman.com/casebook/workspace/casebook/request/21327246-232c34c3-f0eb-4531-b37d-032c913235e9?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b) or [Cases - Fetch a Case by ID](https://www.postman.com/casebook/workspace/casebook/request/21327246-a085264f-0602-4926-8064-72819ae958b0?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b) endpoints in the Cases API: ``` {  "data": {    "id": "ab47a706-59b0-44b5-bc9b-6986ce8c7668",    "type": "cases",    "attributes": {      "name": "Smith Family Housing Support",     "custom_fields": {       "programTier": "f47ac10b-58cc-4372-a567-0e02b2c3d479",       "monthlyRentSubsidy": 450.50,       "veteranHousehold": true,       "lastInspectionDate": "2023-11-15",       "assignedOutreachRegion": "Northwest"      }    }  }} ``` This sample case has five custom fields - four with values set which can be used like the default attributes in the case.  However `programTier` has an ID set, indicating that a dropdown option has been selected which will require a lookup. The following endpoints will describe how to look up custom fields and/or dropdown options for mapping or to use programmatically. #### Query all custom fields [Admin - GET Entity Field Configurations](https://www.postman.com/casebook/workspace/casebook/request/21327246-908e93df-76ab-4d16-89fb-b86e8d051cc8?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b) can be used to retrieve a list of custom fields in Casebook, including the field's `name`, `field_type`, `is_required`, and`label` attributes. ``` YOUR_CUSTOM_FIELD_NAME> ``` - Headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` - Body: N/A - Query Parameters: - `filter[name]`: `` #### Query all dropdown options (dynamic enums) for a dropdown custom field The value of a custom text, number, Boolean, and date fields can be used without any additional interpretation. However custom dropdown fields require an additional step to read or write a value. In order to read or populate a custom field that is configured as a dropdown, it is necessary to first retrieve a list of available options. [Admin - GET Dynamic Enums](https://www.postman.com/casebook/workspace/casebook/request/21327246-1cfe1b32-8350-4120-9776-842fc66b63d5?action=share&creator=21327246&active-environment=21327246-f6edc838-e553-4996-82da-f1a51307377b) can be used to retrieve a list of dropdown options in Casebook ``` GET /admin/dynamic_enums ``` - Headers: - Authorization: `Bearer ` - Content-Type: `application/vnd.api+json` - Body: N/A - Query Parameters: - `filter[entity_field_configuration.name]`: `` ### Tips **Filtering custom fields by `name` can be used to quickly and reliably lookup a custom field** returned in Case, Intake Report, and/or People records (e.g. `?filter[name]=programTier`) **Similarly, filtering dropdown options by `entity_field_configuration.name` returns dropdown options** for a specific custom field (e.g. `?filter[entity_field_configuration.name]=programTier`) ### Next steps Next, fetch records which support custom fields to get started: - [Work with the Cases API](https://gohub.casebook.net/knowledge/working-with-cases-api) - [Work with the Intake API](https://gohub.casebook.net/knowledge/working-with-intake-reports) - [Work with the People API](https://gohub.casebook.net/knowledge/working-with-people) --- For more help with the Casebook API, [get in touch with the Casebook Support team](https://gohub.casebook.net/knowledge/get-help-in-casebook). - [Getting Started With Casebook](https://gohub.casebook.net/knowledge/getting-started-with-casebook#main-content) - [Casebook Overview](https://gohub.casebook.net/knowledge/getting-started-with-casebook#casebook-overview) - [Getting Started for New Users](https://gohub.casebook.net/knowledge/getting-started-with-casebook#getting-started-for-new-users) - [Services in Casebook](https://gohub.casebook.net/knowledge/getting-started-with-casebook#services-in-casebook) - [Notes](https://gohub.casebook.net/knowledge/getting-started-with-casebook#notes) - [Admin](https://gohub.casebook.net/knowledge/admin#main-content) - [Casebook Security](https://gohub.casebook.net/knowledge/admin#casebook-security) - [Roles and Permissions](https://gohub.casebook.net/knowledge/admin#roles-and-permissions) - [User Management](https://gohub.casebook.net/knowledge/admin#user-management) - [Notifications](https://gohub.casebook.net/knowledge/admin#notifications) - [Data](https://gohub.casebook.net/knowledge/admin#data) - [Field Configuration](https://gohub.casebook.net/knowledge/admin#field-configuration) - [Dynamic Fields](https://gohub.casebook.net/knowledge/admin#dynamic-fields) - [Forms](https://gohub.casebook.net/knowledge/admin#forms) - [Implementation & Adoption](https://gohub.casebook.net/knowledge/admin#implementation-adoption) - [People](https://gohub.casebook.net/knowledge/people) - [Intake](https://gohub.casebook.net/knowledge/intake) - [Engage](https://gohub.casebook.net/knowledge/engage#main-content) - [Text Messages](https://gohub.casebook.net/knowledge/engage#text-messages) - [Configuration](https://gohub.casebook.net/knowledge/engage#configuration) - [Notes](https://gohub.casebook.net/knowledge/engage#notes) - [Track](https://gohub.casebook.net/knowledge/track) - [Access](https://gohub.casebook.net/knowledge/access) - [Workflow & Tasks](https://gohub.casebook.net/knowledge/workflow-tasks) - [Reporting](https://gohub.casebook.net/knowledge/reporting#main-content) - [Overview](https://gohub.casebook.net/knowledge/reporting#overview) - [Datasets](https://gohub.casebook.net/knowledge/reporting#datasets) - [Dashboards](https://gohub.casebook.net/knowledge/reporting#dashboards) - [Pre-built Reports](https://gohub.casebook.net/knowledge/reporting#pre-built-reports) - [Custom Reports](https://gohub.casebook.net/knowledge/reporting#custom-reports) - [Data Visualizations](https://gohub.casebook.net/knowledge/reporting#data-visualizations) - [Filters](https://gohub.casebook.net/knowledge/reporting#filters) - [Calculated Fields](https://gohub.casebook.net/knowledge/reporting#calculated-fields) - [Other](https://gohub.casebook.net/knowledge/reporting#other) - [Audit Logs](https://gohub.casebook.net/knowledge/audit-logs) - [Integrations](https://gohub.casebook.net/knowledge/integrations#main-content) - [Low-code incoming integrations with Zapier](https://gohub.casebook.net/knowledge/integrations#low-code-incoming-integrations-with-zapier) - [Custom incoming integrations with Casebook API](https://gohub.casebook.net/knowledge/integrations#custom-incoming-integrations-with-casebook-api) - [Custom outgoing integrations with Webhooks](https://gohub.casebook.net/knowledge/integrations#custom-outgoing-integrations-with-webhooks) - [Program Area Specific](https://gohub.casebook.net/knowledge/program-area-specific#main-content) - [VOCA Reporting](https://gohub.casebook.net/knowledge/program-area-specific#voca-reporting) - [Customer Support](https://gohub.casebook.net/knowledge/customer-support#main-content) - [Getting Unstuck](https://gohub.casebook.net/knowledge/customer-support#getting-unstuck) - [Account Management](https://gohub.casebook.net/knowledge/customer-support#account-management) - [Product Release Notes](https://gohub.casebook.net/knowledge/product-release-notes#main-content) - [2026](https://gohub.casebook.net/knowledge/product-release-notes#2026) - [2025](https://gohub.casebook.net/knowledge/product-release-notes#2025) - [2024](https://gohub.casebook.net/knowledge/product-release-notes#2024) - [2023](https://gohub.casebook.net/knowledge/product-release-notes#2023) - [2022](https://gohub.casebook.net/knowledge/product-release-notes#2022) - [2021](https://gohub.casebook.net/knowledge/product-release-notes#2021) - [2020](https://gohub.casebook.net/knowledge/product-release-notes#2020) - [Frequently Asked Questions](https://gohub.casebook.net/knowledge/frequently-asked-questions#main-content) - [Global](https://gohub.casebook.net/knowledge/frequently-asked-questions#global) - [Casebook Calendar](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-calendar) - [Casebook Services](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-services) - [Casebook Forms](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-forms) - [Casebook Notes](https://gohub.casebook.net/knowledge/frequently-asked-questions#casebook-notes) - [cb Admin](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-admin) - [cb Track](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-track) - [cb Reporting](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-reporting) - [cb Access](https://gohub.casebook.net/knowledge/frequently-asked-questions#cb-access) - [Program Specific](https://gohub.casebook.net/knowledge/frequently-asked-questions#program-specific) [![logo-raspberry-1-1](https://gohub.casebook.net/hs-fs/hubfs/logo-raspberry-1-1.png?width=32&height=30&name=logo-raspberry-1-1.png "logo-raspberry-1-1")](https://www.casebook.net/) © 2025 Casebook. All rights reserved. Casebook Knowledge Base [Video Library](https://gohub.casebook.net/video-library) [Still Need Help?](https://gohub.casebook.net/knowledge/kb-tickets/new)