APICustom field

Get a custom field definition

GET
/public/v1/custom-fields/{id}

Get one custom field definition by its numeric id, scoped to the authenticated company.

Use this to resolve a field's current type, options, and settings — for example before writing a value into an entity's custom_data, where this same id is the map key. Returns 404 when no field with that id belongs to the company (a field owned by another company is indistinguishable from one that does not exist). Read-only; touches nothing in inventory or compliance.

Required permission: settings_permissions_custom_fields.

Authorization

Bearer
headerAuthorizationBearer <token>

API token generated in Distru (Settings → Distru API). Send it on every request as Authorization: Bearer YOUR_API_TOKEN.

Path Parameters

id*integer

The numeric id of the custom field, as returned by the list endpoint and used as the key inside each record's custom_data. Example: 482

Response Body

A single custom field definition

*/*
  1. response

A single custom field definition wrapped in a data envelope

data?

A custom field definition

Example Request
curl -X GET 'https://app.distru.com/public/v1/custom-fields/74'
Example Response
{  "data": {    "description": "A test field",    "disabled_field_options": [      "B"    ],    "field_options": [      "A",      "B",      "C"    ],    "field_type": "dropdown",    "filterable": true,    "id": 10,    "name": "Test Field",    "parent_object": "product",    "required": false  }}