Custom properties

Get a custom property detail for a given entity type

Returns a list of all custom properties in your dotfile workspace for a given entity type

get/v1/custom-properties/{target_entity}/{key}

Request

  • Base URL
    https://api.dotfile.com
  • Auth
    API key in header X-DOTFILE-API-KEY

Path parameters

target_entity'case' | 'company' | 'individual' required

Entity type to retrieve custom properties for.

keystring required
Example:last_audit

The custom property key

Response

Detailed custom property

ℹ️ Click to see full payload

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "settings": {
    "max": 100,
    "currency_code": "EUR"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.