> For a complete page index, fetch https://developer.close.com/llms.txt

# Custom Fields

Custom Fields let you store arbitrary data on [**Leads**](https://developer.close.com/api/resources/leads/list),
[**Contacts**](https://developer.close.com/api/resources/contacts/list),
[**Opportunities**](https://developer.close.com/api/resources/opportunities/list), and
[**Custom Activities**](/api/resources/custom-activities).

When creating a Custom Field, you define its name, the type of data that's going
to be stored on it, whether it can store multiple values or not, who in your
organization can edit its values, etc. In other words, you fully control how
it's going to be displayed in the Close UI and how its values are going to be
validated and stored. This allows you to adjust your Close data to fit your
sales process perfectly.
[Learn more about Custom Fields](https://help.close.com/docs/custom-fields).

There are several endpoints that you can use to manage your Custom Fields:

- [Lead Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/list)
  (`/custom_field/lead/`) – manage regular Custom Fields assigned to Leads.
- [Contact Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/list)
  (`/custom_field/contact/`) – manage regular Custom Fields assigned to
  Contacts.
- [Opportunity Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/list)
  (`/custom_field/opportunity/`) – manage regular Custom Fields assigned to
  Opportunities.
- [Activity Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/list)
  (`/custom_field/activity/`) – manage regular Custom Fields assigned to a
  specific Custom Activity.
- [Custom Object Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/list)
  (`/custom_field/custom_object_type/`) – manage regular Custom Fields assigned
  to a specific Custom Object.
- [Shared Custom Field API](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/list)
  (`/custom_field/shared/`) – manage Shared Custom Fields. These are Custom
  Fields that can be associated with one or more objects. For example, a single
  Shared Custom Field can be assigned to Leads, and several different Custom
  Activities.
- [Shared Custom Field Association API](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/create-association)
  (`/custom_field/shared/{cf_id}/association/`) – manage which objects a given
  Shared Custom Field is associated with and control some of the
  association-specific properties (e.g. whether a value for the given Field
  should be required on the given object).
- [Custom Field Schema API](https://developer.close.com/api/resources/custom-fields/custom-field-schemas/get)
  (`/custom_field_schema/{object_type}/`) – efficiently fetch _all_ (regular and
  shared) Custom Fields and control the order in which they're going to be
  displayed in the UI. _We recommend this endpoint for fetching Custom Fields
  available in your organization._

A Custom Field has the following attributes:

- `name` – the user-readable name of this Field.
- `description` – a longer description of the Field that may be shown to users
  for context. The description may be null and has a 280 character limit.
- `type` – determines the data type of the values that can be stored on this
  Field. The available types are:
  - `text`: accepts any text value, e.g. `"Some Value"`.
  - `number`: accepts numeric values - both integers and decimals, e.g. `2` or
    `5.5`.
  - `date`: accepts date values (without the time component), e.g.
    `"2014-06-12"`.
  - `datetime`: accepts date values (including the time component), e.g.
    `"2014-06-27T22:00:00-08:00"`.
  - `choices:` accepts only the values that are specified in the `choices` field
    of this Custom Field, e.g. `"some valid choice"`.
  - `user`: accepts IDs (recommended) and names (exact match only) of Users who
    are active or former members of your organization (e.g.
    `"user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"` or `"John Doe"`) and
    always returns IDs.
  - `contact`: accepts IDs of Contacts, limited to the Contacts that exist on
    the Lead you're editing:
    - If you're editing a Lead, only Contacts belonging to this Lead are
      accepted.
    - If you're editing a Contact, only Contacts belonging to the Lead that this
      that this Contact belongs to are accepted.
    - If you're editing an Opportunity, only Contacts belonging to the Lead that
      this Opportunity belongs to are accepted.
    - If you're editing a Custom Activity, only Contacts belonging to the Lead
      that this Custom Activity belongs to are accepted.
    - If you're editing a Custom Object, only Contacts belonging to the Lead
      that this Custom Object belongs to are accepted.
  - `custom_object`: accepts IDs of Custom Object Instances.
    - Can only store Custom Object IDs of a single type, determined by
      `referenced_custom_type_id` listed below.
    - Limited to the Custom Object instances that exist on the Lead you're
      editing, following similar rules to the `contact` field listed above.
  - `textarea`: accepts any text value (just like the `text` type), but displays
    a multi-line textarea in the Close UI. Currently, this type of a Custom
    Field is only supported on
    [**Custom Activities**](/api/resources/activities/custom-activities).
  - `hidden`: accepts any value but is never shown in the UI. It's a good place
    to store information useful only to API integrations.
- `choices` – a list of valid values for a `choices` type Custom Field.
- `accepts_multiple_values` – determines if multiple values can be assigned to
  this Custom Field. Multiple values are currently only supported for the
  `user`, `choices`, `contact`, and `custom_object` type Custom Fields.
- `editable_with_roles` – list of [Roles](https://developer.close.com/api/resources/roles/list) that can edit the
  values of this Custom Field. Empty if the editing is not restricted.
- `referenced_custom_type_id`: stores the ID of the Custom Object Type this
  field references. Relevant only on `custom_object` type fields.
- `back_reference_is_visible`: If true, this field will also display a back
  reference in the Close UI, listing objects that reference the given Custom
  Object. Relevant only on `custom_object` type fields.

Note that you can only create/edit/delete Custom Fields if your User's Role has
the `manage_organization` permission.

> Store arbitrary data on Leads, Contacts, Opportunities, and Custom Activities using Custom Fields.

## Docs

- [Custom Field Schemas](https://developer.close.com/api/resources/custom-fields/custom-field-schemas.md): Returns all Custom Fields for a given object type in the order you have defined.
- [Shared](https://developer.close.com/api/resources/custom-fields/custom-fields-shared.md): Shared Custom Fields can be associated with multiple object types.

## API Docs

- Custom Field Schemas [Retrieve a custom field schema](https://developer.close.com/api/resources/custom-fields/custom-field-schemas/get.md)
- Custom Field Schemas [Update a custom field schema](https://developer.close.com/api/resources/custom-fields/custom-field-schemas/update.md)
- Lead Custom Fields [List Lead Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/list.md)
- Lead Custom Fields [Create a new Lead Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/create.md)
- Lead Custom Fields [Fetch Lead Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/get.md)
- Lead Custom Fields [Update a Lead Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/update.md)
- Lead Custom Fields [Delete a Lead Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-lead/delete.md)
- Contact Custom Fields [List Contact Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/list.md)
- Contact Custom Fields [Create a new Contact Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/create.md)
- Contact Custom Fields [Fetch Contact Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/get.md)
- Contact Custom Fields [Update a Contact Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/update.md)
- Contact Custom Fields [Delete a Contact Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-contact/delete.md)
- Opportunity Custom Fields [List Opportunity Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/list.md)
- Opportunity Custom Fields [Create a new Opportunity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/create.md)
- Opportunity Custom Fields [Fetch Opportunity Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/get.md)
- Opportunity Custom Fields [Update an Opportunity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/update.md)
- Opportunity Custom Fields [Delete an Opportunity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-opportunity/delete.md)
- Activity Custom Fields [List Activity Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/list.md)
- Activity Custom Fields [Create a new Activity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/create.md)
- Activity Custom Fields [Fetch Activity Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/get.md)
- Activity Custom Fields [Update an Activity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/update.md)
- Activity Custom Fields [Delete an Activity Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-activity/delete.md)
- Custom Object Custom Fields [List Custom Object Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/list.md)
- Custom Object Custom Fields [Create a new Custom Object Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/create.md)
- Custom Object Custom Fields [Fetch Custom Object Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/get.md)
- Custom Object Custom Fields [Update a Custom Object Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/update.md)
- Custom Object Custom Fields [Delete a Custom Object Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-custom-object/delete.md)
- Shared Custom Fields [List Shared Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/list.md)
- Shared Custom Fields [Create a new Shared Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/create.md)
- Shared Custom Fields [Fetch Shared Custom Field's details](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/get.md)
- Shared Custom Fields [Update a Shared Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/update.md)
- Shared Custom Fields [Delete a Shared Custom Field](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/delete.md)
- Shared Custom Fields [Associate a Shared Custom Field with an object type](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/create-association.md)
- Shared Custom Fields [Fetch a Shared Custom Field Association](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/get-association.md)
- Shared Custom Fields [Update an existing Shared Custom Field Association](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/update-association.md)
- Shared Custom Fields [Disassociate a Shared Custom Field from an object type](https://developer.close.com/api/resources/custom-fields/custom-fields-shared/delete-association.md)

## OpenAPI Specification

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