Skip to content

List custom-field definitions​

GET
/custom-fields/definitions

Returns the active CustomFieldDefinition set for the given subject — platform system rows merged with the tenant's custom rows (tenant wins on key collisions). Archived rows are excluded. Use this to introspect the schema before posting to the corresponding subject endpoint.

Authorizations​

BearerAuth

API key in the form one_pk_<random>. Mint at /settings/api-keys.

Type
HTTP (bearer)

Parameters​

Query Parameters

subject*

The subject type whose custom-field schema to introspect (e.g. customer-profile, invoice). Required.

Type
string
Required
Example"example"

Responses​

List of definitions (snake_case keys) with subject + total count.

application/json
JSON
{
  
"meta": {
  
  
"version": 0,
  
  
"subject": "string",
  
  
"total": 0
  
},
  
"data": [
  
  
{
  
  
  
"id": "string",
  
  
  
"key": "string",
  
  
  
"label": "string",
  
  
  
"type": "string",
  
  
  
"type_config": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"required": true,
  
  
  
"default_value": null,
  
  
  
"position": 0,
  
  
  
"group": "string",
  
  
  
"show_if": "string",
  
  
  
"kind": "string",
  
  
  
"help_text": "string"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

OneBusiness · Built for businesses that work.