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 all custom fields

GET /api/v1/custom_field_definitions

To update a worksheet, match its key and custom_fieldable_type, then find the intended input row by name in worksheet_rows (equation: null). Calculated rows expose their equation as a string. Rows are discoverable even when the worksheet has no saved values.

Use the row's id, not the definition's id, as the update key. Row IDs can be reused across records using the same worksheet definition, but not independently created or copied worksheets. Existing record permissions still apply.

Example request

GET /api/v1/custom_field_definitions

Example CURL command

curl -g "https://company.aha.io/api/v1/custom_field_definitions" -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