Custom fields API

Custom fields are defined by record type, and are shared across all workspaces across the account. Fields must be added to a layout before they will appear on a record.

For custom fields that include options, (e.g. tags, choice lists), you can also load the list of all available options.

List options for a custom field

GET /api/v1/custom_field_definitions/:custom_field_definition_id/options

Parameters
Name	Description
`custom_field_definition_id *`	Numeric ID of the custom field

Example request

GET /api/v1/custom_field_definitions/581360680/options

Example CURL command

curl -g "https://company.aha.io/api/v1/custom_field_definitions/581360680/options" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body