Skip to main content
GET
/
action-templates
Get all Action Templates
curl --request GET \
  --url https://api-v2.boost.xyz/action-templates
[
  {
    "actionTemplate": {
      "id": "<string>",
      "actionType": "mint",
      "description": "Reward any who buys a specific ERC-20 token on Zora",
      "title": "Buy a specific token",
      "boostConfig": {
        "selectedContract": {
          "ID": "eth:8453:0x777777751622c0d3258f214f9df38e35bf45baf3",
          "contract_name": "<string>",
          "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "deployment_information": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "network_id": "8453"
          }
        },
        "selectedSignature": "event CoinCreated(address indexed caller, address indexed payoutRecipient, address indexed platformReferrer, address currency, string uri, string name, string symbol, address coin, address pool, string version)",
        "parameterFilters": [
          {
            "id": "<string>",
            "parameter": "to:1",
            "comparator": "==",
            "value": "<string>",
            "tupleParameter": "<string>",
            "tupleParameters": [
              "field1:1"
            ]
          }
        ],
        "logFilters": [
          {
            "id": "<string>",
            "contract": {
              "ID": "eth:8453:0x777777751622c0d3258f214f9df38e35bf45baf3",
              "contract_name": "<string>",
              "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
              "deployment_information": {
                "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
                "network_id": "8453"
              }
            },
            "signature": "event Transfer(address indexed from, address indexed to, uint256 amount)",
            "parameters": [
              {
                "id": "<string>",
                "parameter": "to:1",
                "comparator": "==",
                "value": "<string>",
                "tupleParameter": "<string>",
                "tupleParameters": [
                  "field1:1"
                ]
              }
            ],
            "signatureHash": "0xb362243af1e2070d7d5bf8d713f2e0fab64203f1b71462afbe20572909788c5e"
          }
        ],
        "claimantContract": {
          "ID": "eth:8453:0x777777751622c0d3258f214f9df38e35bf45baf3",
          "contract_name": "ZoraTimedSaleStrategy",
          "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
          "deployment_information": {
            "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7",
            "network_id": "7777777"
          }
        },
        "claimantSignature": "function mint(address mintTo, uint256 quantity, address collection, uint256 tokenId, address mintReferral, string comment) payable",
        "claimantParameterMapping": "mintTo",
        "reward": {
          "budget": "<string>",
          "amount": "<string>",
          "rebatePercentage": 123,
          "type": "pegged-variable-criteria",
          "peg": "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913 or \"buyToken:2\""
        },
        "selectedSignatureHash": "0xb362243af1e2070d7d5bf8d713f2e0fab64203f1b71462afbe20572909788c5e",
        "selectedAbiItem": {},
        "claimantSignatureHash": "0xb362243af1e2070d7d5bf8d713f2e0fab64203f1b71462afbe20572909788c5e",
        "criteria": {
          "signature": "0xb362243af1e2070d7d5bf8d713f2e0fab64203f1b71462afbe20572909788c5e",
          "valueType": 123,
          "fieldIndex": 123,
          "criteriaType": 123,
          "targetContract": "<string>"
        },
        "rewardMultiplier": "4000000000000",
        "distributionChannel": [
          "public"
        ]
      },
      "nameConfig": {
        "template": "<string>",
        "boostNameGenerator": "<string>",
        "abiFilters": [
          {
            "signature": "0x00000000000000000000000000000000000000000000000000000000a836f32f",
            "inputArgIndexes": [
              123
            ],
            "inputArgValues": [
              "<string>"
            ],
            "targetContract": "<string>"
          }
        ]
      },
      "isActive": true,
      "urlTemplate": "<string>",
      "allowlist": [
        "0x378632819f39c74c4f56b1429e760739c5fb51b7"
      ],
      "distributionChannel": [
        "public"
      ],
      "verificationLevel": "<string>",
      "builderMetadata": {
        "createdAt": "2023-11-07T05:31:56Z",
        "actionChain": 123,
        "budgetAccount": {
          "chainId": 123,
          "address": "0x378632819f39c74c4f56b1429e760739c5fb51b7"
        },
        "txHash": "<string>",
        "description": "<string>",
        "contactInfo": "<string>",
        "projectUrl": "<string>",
        "projectIconUrl": "<string>",
        "isProjectCreator": true
      },
      "status": "pending",
      "projectId": "zora"
    },
    "project": {
      "id": "zora",
      "url": "<string>",
      "icon": "<string>"
    }
  }
]

Query Parameters

address
string

Filter by budget account address

Example:

"0x378632819f39c74c4f56b1429e760739c5fb51b7"

onlyActive
boolean
default:true

Only return active templates (default: true)

Response

200 - application/json

Returns a list of all Action Templates registered to the system

actionTemplate
object
required
project
object
required