--- title: "Get an Action Template by actionTemplateId" method: GET path: "/action-templates/:id" tags: ["Action", "Action Template"] --- # Get an Action Template by actionTemplateId `GET /action-templates/:id` Returns an Action Template by actionTemplateId ## Response `200` Returns a specific Action Template by actionTemplateId - object - `actionTemplate` object, required - `id` string, required — An arbitrary UUID uniquely identifying each Action Template - `actionType` string, required — A readable slug representing the type of action that must be taken in order to be eligible for a Boost claim, like "mint", or "create-any-token", or "buy-specific-token" - `projectId` string — A readable slug representing the name of a project known to the Boost API, like "zora", or "coinboost" - `description` string, required — Human readable text describing the action that must be taken in order to be eligible for a Boost claim - `title` string, required — Brief human readable text describing the action that must be taken in order to be eligible for a Boost claim - `boostConfig` object, required — An object containing information on how to interact with a project's smart contract as to be eligible for a Boost claim. Details include the target contract, ABI, function signature, event signature, and reward template information that can be used when configuring a Boost Action when creating a new Boost. - `selectedContract` object, required - `ID` string, required — A system ID of the format: "eth:chainId:contractAddress" representing the smart contract that a Boost Action needs to target - `contract_name` string, required — The contract's name from the original ABI - `address` string, required — The address of the deployed contract - `deployment_information` object, required - `address` string, required — The address of the deployed contract - `network_id` string, required — The chain ID of the deployed contract - `selectedSignatureHash` string - `selectedSignature` string, required — The human readable event or function signature - `parameterFilters` object[], required — An array of function parameter details describing parameters of note, and comparators for the Boost Protocol to use when evaluating claims - `id` string, required — A unix timestamp when this was added - `parameter` string, required — A string representing the name of the argument and the index of the argument, for example: "to:1" - `comparator` string, required — When validating a claim, how should we compare equality, for example: ">", "<", "==", etc. - `value` string, required — The value to compare the parameter to using associated comparator and parameter - `tupleParameter` string — DEPRECATED: Use tupleParameters instead. Legacy field for single-level tuple support. - `tupleParameters` string[] — Array of tuple parameter names for nested tuple support. Single level: ["field1:1"], Nested: ["field1:1", "nestedField:0", "deepField:2"] - `logFilters` object[], required - `id` string, required - `contract` object, nullable, required — The contract address to filter on - `ID` string, required — A system ID of the format: "eth:chainId:contractAddress" representing the smart contract that a Boost Action needs to target - `contract_name` string, required — The contract's name from the original ABI - `address` string, required — The address of the deployed contract - `deployment_information` object, required - `address` string, required — The address of the deployed contract - `network_id` string, required — The chain ID of the deployed contract - `signatureHash` string - `signature` string, nullable, required — The event signature to filter on. Must be in event-definition format (see example) - `parameters` object[], required — An array of function parameter details - `id` string, required — A unix timestamp when this was added - `parameter` string, required — A string representing the name of the argument and the index of the argument, for example: "to:1" - `comparator` string, required — When validating a claim, how should we compare equality, for example: ">", "<", "==", etc. - `value` string, required — The value to compare the parameter to using associated comparator and parameter - `tupleParameter` string — DEPRECATED: Use tupleParameters instead. Legacy field for single-level tuple support. - `tupleParameters` string[] — Array of tuple parameter names for nested tuple support. Single level: ["field1:1"], Nested: ["field1:1", "nestedField:0", "deepField:2"] - `selectedAbiItem` object — The original function or event AbiItem for the action that must be completed in order to be eligible to complete a Boost - `claimantContract` object, required - `ID` string, required — A system ID of the format: "eth:chainId:contractAddress" representing the smart contract where a Boost can derive information on who's eligible to claim - `contract_name` string, required — The original name of the smart contract from its ABI - `address` string, required — The address of the smart contract - `deployment_information` object, required — An object specifying how to configure the Action claimant when creating a new Boost - `address` string, required — The address of the deployed smart contract - `network_id` string, required — The chain ID where the smart contract is deployed - `claimantSignatureHash` string - `claimantSignature` string, required - `claimantParameterMapping` string, required — The name of the event or function argument representing how to derive the address of the person eligible for the claim - `reward` object, required — An object specifying placeholder values to use when initializing Boost Incentives when creating a Boost - `type` 'fixed' | 'usd-pegged' | 'eth-pegged' | 'transaction-value' | 'variable-criteria' | 'pegged-variable-criteria' | 'usd-pegged-variable-criteria' — A system enum representing the type of incentive to bootstrap creation with - `budget` string, required — A placeholder Budget account address, if it exists - `amount` string, required — A placeholder reward amount, if it exists - `rebatePercentage` number, required — A placeholder percentage to peg the reward amount to - `peg` union — The address of the pegged token, or a dynamic reference like "buyToken:2" that will be resolved from parameter filters. - string — Ethereum address - string - `criteria` object — Configuration for variable criteria reward calculation - `signature` string, required — The hexadecimal event signature for variable criteria rewards - `valueType` number, required — A numeric identifier for the data type of the target value - `fieldIndex` number, required — The index of the field to use for variable criteria evaluation - `criteriaType` number, required — A numeric identifier for the type of criteria evaluation to perform - `targetContract` string, required — Contract address for criteria evaluation - `rewardMultiplier` string — A multiplier value for reward calculations - `distributionChannel` string[] — Array of distribution channels where this action template is available - `nameConfig` object, required — An object containing information on how to derive a human readable name from a Boost configuration. Also includes the hexadecimal function or event signature for the action that must be taken to be eligible for a Boost claim. - `template` string, required — A template string representing how to dynamically name a Boost on creation - `boostNameGenerator` string, required — An internal system enum defining the function to call to generate the display name - `abiFilters` object[], required — A list of objects containing information on event or function selectors that define the action that must be taken in order to be eligible to claim a Boost - `signature` string, required — A hexadecimal string representing the function or event selector. This string will always start with 0x, and end with the 32 byte selector. If selector is a function, then the 4 byte signature will be left padded with zeroes to 32 bytes. - `inputArgIndexes` number[], required — The indexes of the arguments in the function or event signature to take into account when specifying the action to be - `inputArgValues` string[] — Optional array of expected values at each index. Empty string means any value. Must be same length as inputArgIndexes. - `targetContract` string — Optional contract address that must emit this event or have this function called on it - `isActive` boolean, required — Whether this action template is currently active and available for use - `urlTemplate` string, nullable, required — URL template for generating project-specific links, with placeholders for dynamic values - `allowlist` string[], required — Array of Ethereum addresses that are allowed to use this action template. If empty, the template is available to everyone. - `distributionChannel` string[], required — Array of distribution channels where this action template is available - `verificationLevel` string, nullable, required — Verification level needed for an action template - `builderMetadata` object, nullable, required — Metadata about who created the template and how - `txHash` string — Transaction hash used to generate the template - `createdAt` string, date-time, required — ISO timestamp for when the template was created - `actionChain` integer, required — Chain ID where the action transaction occurred - `description` string — Optional description provided for the template - `budgetAccount` object, required — Budget account that created the template - `chainId` integer, required — Chain ID where the budget account is deployed - `address` string, required — Budget account address that created the template - `contactInfo` string — Optional contact information for the template creator - `projectUrl` string, uri — Project URL submitted by template creator (template-level, populated server-side) - `projectIconUrl` string, uri — S3 URL of project icon uploaded by template creator (populated server-side) - `isProjectCreator` boolean — True if this template created the project entry, false if project already existed (populated server-side) - `status` 'pending' | 'approved' | 'rejected' | 'duplicated', required — The approval status of the template - `category` 'defi' | 'nft' | 'gaming' | 'social' | 'bridge' | 'governance' | 'payments' | 'other', nullable, required — The category of the boost action - `project` object, required - `id` string, required — A readable slug representing the name of a project known to the Boost API, like "zora", or "coinboost" - `url` string, required — URL of the project's homepage - `icon` string, required — An image URI that can be used when presenting information about the project ## Other responses - `404` — Not found --- [API](https://skmtc.dev/boost/apis/boost-v2-api.md) · [All operations](https://skmtc.dev/boost/apis/boost-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/boost/boost-v2-api/revisions/23f55c70a429/schema)