get

/v4/schemas/

List schema groups (BETA)

List schema groups

Returns every schema group exposed by this API. A group binds an enum (e.g. CampaignType) to a family of TypeBox JSON Schemas describing the inputs the Merkl engine accepts for each value of that enum.

Current groups:

  • campaignType — config inputs of a campaign of a given CampaignType.
  • campaignTypeExtended — same as campaignType plus distributionChainId and campaignId.
  • distributionMethod — parameters of a given DistributionMethod.
  • computeScoreMethod — parameters of a given ComputeScoreMethod.
  • hookType — parameters of a given HookType.
  • processorType — config of a given ProcessorType.

Pair this endpoint with /v4/enums for the enum value ↔ key mapping.

⚠️ Beta: response shape may change without notice.

Responses

200
Response for status 200
Schema
object
groupsobject[]
required
Available schema groups
namestringSchema group name (e.g., campaignType)
enumNamestringUnderlying enum name (e.g., CampaignType)
valueTypeenumType of the discriminator values used to address a schema in this groupnumberstring
countnumberNumber of schemas available in the group
descriptionstringHuman-readable description of the schema group
Example
{
  "groups": [
    {
      "name": "string",
      "enumName": "string",
      "valueType": "number",
      "count": 0,
      "description": "string"
    }
  ]
}
get
https://api.merkl.xyz/v4/schemas/
Merkl API
curl -X GET "https://api.merkl.xyz/v4/schemas/"