v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB

Schemas

getSchemaGroup

Get a schema group from given group composite ID

get/v1/entity/schemas/group/{composite_id}

Path parameters

composite_idstring required

Example:contact:97644baa-083f-4e49-9188-fcff2ecaad7d

Schema Slug and the Group ID

Response

Success

labelstring required

idstring

orderinteger

Render order of the group

expandedboolean

Expanded by default

render_conditionstring

Only render group when render_condition resolves to true

_purposeClassificationId[]

Only render group when one of the purposes is enabled

_manifeststring[] nullable

Manifest ID used to create/update the schema group

feature_flagstring

This group should only be active when the feature flag is enabled

composite_idstring

schemastring

Schema slug the group belongs to

Example response

{
  "label": "Contact Details",
  "id": "e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "render_condition": "_is_composite_price = \"false\"",
  "_purpose": [
    "taxonomy-slug:classification-slug"
  ],
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "feature_flag": "FF_MY_FEATURE_FLAG",
  "composite_id": "contact:e18a532b-ae79-4d86-a6a5-e5dbfb579d14",
  "schema": "contact"
}