Skip to content
HIPE Logo Developers - HIPE

Custom fields

Prerequisites

Get the custom fields

To get the custom fields available in HIPE, you will need to make a GET request to the /api/custom-field-nodes endpoint. You need to specify the type of the custom field you want to get in our case the opportunity.

Terminal window
curl --location 'https://{ YOUR INSTANCE }-hipe.packitoo.com/api/custom-field-nodes' \
--header 'X-ACCESS-TOKEN: { YOUR ACCESS TOKEN }'

This will return an array of custom fields, each one can be linked to one or multiple metaEntityContexts who link a given custom field to a meta entity as TASKS, COMPANIES, PROJECTS etc.

If you use a custom field with a type:

  • select
  • multiselect
  • checkbox
  • radio
  • multiCheckBox

You will also find for each custom field N options with a given value and label.

If you want to set a custom field value, for example in the context of a project you will need to do:

{
    "customFields": {
        "myCustomFieldText": "Lorem ipsum dolor sit amet",
        "myCustomFieldDate": "2025-04-04T13:01:00.000Z",
        "myCustomFieldWithOneOption": [ -- `multiselect`, `multiCheckBox`
            "myOptionValue"
        ],
        "myCustomFieldWithMultipleOptions": [ -- `multiselect`, `multiCheckBox`
            "myOptionValue1",
            "myOptionValue2"
        ],
        "myCustomFieldWithOptionButNoMultiple": "myOptionValue" -- `select`, `radio`, `checkbox`
    }
}

Find more information in the API reference