Merkl Developer Portal logo
get

/v4/schemas/{groupName}/{typeId}

Get raw JSON Schema for a typed input (BETA)

Get raw JSON Schema for a typed input

Returns the raw TypeBox JSON Schema describing the inputs accepted for a specific entry of a group. The returned object is a standard JSON Schema document and can be consumed directly by tooling such as ajv, openapi-typescript, json-schema-to-ts or quicktype.

:typeId accepts either:

  • the enum value — e.g. 1 for CampaignType.INVALID, or FIX_APR for DistributionMethod.FIX_APR;
  • the enum key — e.g. INVALID for CampaignType.INVALID.

Examples:

  • GET /v4/schemas/campaignType/1
  • GET /v4/schemas/distributionMethod/FIX_APR
  • GET /v4/schemas/hookType/APIBOOST

Responds 404 if either groupName is unknown or typeId does not match any value/key of the underlying enum.

⚠️ Beta: the returned schema may evolve as the engine evolves.

Path parameters

groupNamestring
required

Schema group name

typeIdstring
required

Enum value or enum key addressing the schema within the group