GET/api/v1/object/field/active/{objectSlug}

List the active fields of an object, relations included.

Returns what a form or table for this object needs, in one response: the active own fields, the visible fields shared into the object, and one entry per relation with type relation. The title field comes first. A relation entry carries relation_type (hasMany or belongsTo), direction and target_object instead of the settings of a stored field; its slug is the key used for that relation in record relations.

Query parameters:

types — keep these field types: types=select,status or repeated types=select&types=status. Relations are included only when the list contains relation or types is omitted.

Scope: read.<object slug>, for example read.contacts.

Errors:

400 — no object has that slug, or the object is inactive.
422 — types contains an unknown type.

Response 200 (abridged):

{
  "status": 200,
  "message": "Active fields retrieved successfully",
  "data": [
    {
      "id": 912,
      "name": "stage",
      "slug": "stage-k2j9h4g7",
      "label": "Stage",
      "icon": null,
      "type": "select",
      "required": false,
      "default_value": null,
      "options": {
        "values": [
          {
            "id": "6a1f3c9e-2b7d-4e8a-9f0c-1d2e3f4a5b6c",
            "value": "lead",
            "label": "Lead",
            "color": "#3B82F6"
          }
        ]
      },
      "is_active": true,
      "sort_order": 4,
      "group_slug": null,
      "group_ineligible": false,
      "is_system": false,
      "api_only": false,
      "is_shared": false,
      "shared_with": [],
      "is_visible": true,
      "created_at": "2026-08-02T08:30:00.000Z",
      "updated_at": "2026-09-01T11:15:00.000Z"
    },
    {
      "name": "company-mf3k2p9a",
      "slug": "company-mf3k2p9a",
      "label": "Company",
      "type": "relation",
      "icon": "tabler-building",
      "options": {
        "display_columns": [],
        "display_columns_meta": []
      },
      "is_system": false,
      "required": false,
      "default_value": null,
      "is_active": true,
      "api_only": false,
      "relation_type": "belongsTo",
      "direction": "forward",
      "target_object": {
        "slug": "companies",
        "name": "Companies",
        "icon": "tabler-building"
      },
      "target_object_slug": "companies"
    }
  ]
}

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenbearerAuthoptional

Stored only in this browser for the bearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

objectSlugpath · stringrequired

queryquery · stringoptional

Responses

200application/json

Successful response

{
  "id": 1.5,
  "name": "string",
  "slug": "string",
  "label": "string",
  "icon": "string",
  "type": "string",
  "required": true,
  "default_value": "string",
  "options": "string",
  "is_active": true,
  "sort_order": 1.5,
  "group_slug": "string",
  "group_ineligible": true,
  "is_system": true,
  "api_only": true,
  "is_shared": true,
  "shared_with": "string",
  "is_visible": true,
  "created_at": "2026-01-01T00:00:00Z",
  "updated_at": "2026-01-01T00:00:00Z"
}

idnumberrequired

namestringrequired

slugstringrequired

labelstringrequired

iconobjectrequired

typestringrequired

requiredbooleanrequired

default_valueobjectrequired

optionsobjectrequired

Archived (deleted-but-still-referenced) options are stripped — see FieldResponseDto.

is_activebooleanrequired

sort_ordernumberrequired

Order within the field's section — and, for a section-less field, within the flat list. For a placed (shared) field this is the placement's position on THIS Unit, not the home definition's order. Same currency as PUT /object/field/order and as positions[] on the section assign call.

group_slugobjectrequired

The field's section on THIS Unit (FRD-34); null ⇒ the implicit "Ungrouped" bucket, which renders last. null on paths that skip stampSections (nothing grouped, or a write-echo response), so the key is always present on the wire.

group_ineligiblebooleanrequired

FRD-34 — this field can never be moved into a section: the record shell renders it (title, assignee, meta block, status/tag chrome) or it is system-defined. Derived on read rather than stored, so it is right for objects seeded before sections existed and on the write-echo responses.

is_systembooleanrequired

api_onlybooleanrequired

Value-write lock — drives the "API only" toggle's state in field settings.

is_sharedbooleanrequired

CFM-2: is_shared/shared_with are computed by FieldQueryService.mergeWithPlacedFields but were stripped here. false/[] on paths that skip the merge (e.g. findBySlug).

shared_withobjectrequired

is_visiblebooleanrequired

Per-Unit visibility of a placed (shared) field on THIS Unit — set by mergeWithPlacedFields from the placement row. Own fields (and paths that skip the merge) default to true; their on/off switch is is_active.

created_atstring · date-timerequired

updated_atstring · date-timerequired

400application/json

Bad request

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}

statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

401application/json

Unauthorized

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}

statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.

500application/json

Internal server error

{
  "status": 1,
  "message": "string",
  "code": "string",
  "data": {}
}

statusintegerrequired

The HTTP status code of the response.

messagestringrequired

What went wrong. Several validation messages are joined with ", ".

codestringoptional

A stable, machine-readable reason. Only some errors set it.

dataobjectoptional

Extra detail about the error. Only some errors set it.