# Custom Field Sets

Custom Field Sets contain custom fields and definitions of each fields' subject type. The supported
subjects are currently *Workspace*, *Story*, *User*, and *WorkspaceGroup*.

## Fetching a list of Custom Field Sets

 - [GET /custom_field_sets](https://developer.kantata.com/kantata/specification/custom-field-sets/get-custom-field-sets.md): This endpoint returns structured Custom Field Set objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the custom_field_sets top-level JSON key.
Please see our Response Format section for more information.

## Creating a new Custom Field Set

 - [POST /custom_field_sets](https://developer.kantata.com/kantata/specification/custom-field-sets/create-custom-field-set.md): To create a custom field, the current user must be the Account Administrator.

This endpoint returns structured Custom Field Set objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the custom_field_sets top-level JSON key.
Please see our Response Format section for more information.

## Fetching a single Custom Field Set

 - [GET /custom_field_sets/{id}](https://developer.kantata.com/kantata/specification/custom-field-sets/get-custom-field-set.md): This endpoint returns structured Custom Field Set objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the custom_field_sets top-level JSON key.
Please see our Response Format section for more information.

## Updating an existing Custom Field Set

 - [PUT /custom_field_sets/{id}](https://developer.kantata.com/kantata/specification/custom-field-sets/update-custom-field-set.md): To update a custom field, the current user must be the Account Administrator.

NOTE: subject_type cannot be changed.


This endpoint returns structured Custom Field Set objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the custom_field_sets top-level JSON key.
Please see our Response Format section for more information.

## Deleting an existing Custom Field Set

 - [DELETE /custom_field_sets/{id}](https://developer.kantata.com/kantata/specification/custom-field-sets/delete-custom-field-set.md): The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.

