Custom Data

Get entity custom data settings

Custom data lets you define and use your own document properties as a complement to the default properties that all documents have, such as company name, document title and creation date. Instead of being limited to the standard document fields you can create properties like Project ID, Purchase Order Number, Department or Industry Type.

This call will return the custom data settings for the current entity. The default properties are always prefixed with a plus sign (+) and are not editable.

The label field is deprecated, use the translations array instead. label continues to be returned for backward compatibility and is resolved from the translations.

The options array is only returned for properties with value_type setValues and lists the allowed values that can be assigned on a document.

get/v1/custom-data/entity

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/custom-data/entity
  • Auth: HTTP bearer

Response

The request succeeded.

entity_idstring required

Id of the entity the custom data settings belong to.

Changes

No recorded changes to this operation across all 1 revision of this API.