Skip to main content
GET
/
api
/
field
Returns the complete collection of core and custom fields for the current tenant.
curl --request GET \
  --url https://{install}/api/field \
  --header 'Authorization: Bearer <token>'
{
  "typeDate": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "minimum": "2023-11-07T05:31:56Z",
      "maximum": "2023-11-07T05:31:56Z",
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeDecimal": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "minimum": 123,
      "maximum": 123,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeInteger": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "minimum": 123,
      "maximum": 123,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeList": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "multiSelect": true,
      "data": [
        {
          "id": "<string>",
          "value": "<string>",
          "image": "<string>",
          "metadata": "<string>",
          "active": true
        }
      ],
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typePercent": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "minimum": 123,
      "maximum": 123,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typePicker": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "scope": "<string>",
      "multiSelect": true,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeText": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "contentType": "<string>",
      "maximum": 123,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeTime": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "allowDay": true,
      "allowHour": true,
      "allowMinute": true,
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ],
  "typeToggle": [
    {
      "entity": "<string>",
      "fieldType": "<string>",
      "defaultValue": "<string>",
      "name": "<string>",
      "prompt": "<string>",
      "description": "<string>",
      "isCore": true,
      "isFeature": true,
      "featureName": "<string>",
      "placement": [
        123
      ],
      "usage": [
        123
      ],
      "listEditable": true,
      "tenantId": "<string>",
      "id": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "updated": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "deleted": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Response

The field collection.

All field definitions visible to a tenant, bucketed by type. Acts as the lookup surface for "give me the id of the Status field" / "what's the data list on Priority" — used at item-build time (server onboarding, CLI apply layer) and at rule-evaluation time.

​
typeDate
object[]
​
typeDecimal
object[]
​
typeInteger
object[]
​
typeList
object[]
​
typePercent
object[]
​
typePicker
object[]
​
typeText
object[]
​
typeTime
object[]
​
typeToggle
object[]