---
title: "List custom field definitions"
method: GET
path: "/public/v1/custom-fields"
tags: ["CustomField"]
---

# List custom field definitions

`GET /public/v1/custom-fields`

List every custom field definition owned by the authenticated company.

A custom field is a user-defined attribute attached to one entity type (its `parent_object`) — for example an extra `Batch #` text field on orders or a `Lab` dropdown on packages. Once defined, the field becomes available on every record of that entity type, and callers populate it per-record through that entity's `custom_data` map on its own create/update endpoint (the numeric `id` returned here is the key used inside `custom_data`).

Pass `parent_object` to return only the fields for one entity type; omit it to return the company's fields across all entity types. This is a read-only settings lookup and changes nothing in inventory or compliance.

Required permission: `settings_permissions_custom_fields`.

## Query parameters

- `parent_object` string

## Response `200`

List of custom field definitions

## Other responses

- `400` — Invalid parameters
- `401` — Missing or invalid API token
- `403` — The API token lacks the required permission

---

[API](https://skmtc.dev/distru/apis/distru-api.md) · [All operations](https://skmtc.dev/distru/apis/distru-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/distru/distru-api/revisions/eb775b7b6ee0/schema)