# Claimr

## Docs

- [Getting started](https://docs.claimr.io/getting-started/overview.md): Find your way into creating an account, signing in, resetting your password, and editing your profile.
- [Create a Claimr account and activate it](https://docs.claimr.io/getting-started/create-an-account.md): Sign up for Claimr, fill in your details, and activate your account so you can start exploring the admin panel.
- [Sign in to your Claimr account](https://docs.claimr.io/getting-started/sign-in-to-your-account.md): Access your personalized Claimr dashboard with your email and password, or sign in with your Google account.
- [Reset your Claimr account password](https://docs.claimr.io/getting-started/reset-password.md): Forgot your password? No worries! Follow these steps to regain access to your Claimr account.
- [Edit your Claimr profile](https://docs.claimr.io/getting-started/edit-profile.md): Update your account details from your Claimr profile settings.
- [Claimr core components](https://docs.claimr.io/claimr-core-components.md): Create engaging, gamified experiences that captivate your users and drive desired actions with Claimr.
- [Campaigns](https://docs.claimr.io/campaigns/overview.md): See what you can do with Claimr campaigns and find your way into general settings, referrals, leaderboards, sign-in options, and test users.
- [Create new campaign](https://docs.claimr.io/campaigns/create-new-campaign.md): Launch your first campaign in minutes and start engaging your community with rewards, quests, and gamified experiences.
- [General campaign settings](https://docs.claimr.io/campaigns/general-campaign-settings.md): Configure campaign identity, points, time limits, campaign flow, languages, integrations, block options, notifications, and the Public API.
- [Referral settings](https://docs.claimr.io/campaigns/referral-settings.md): Set a minimum point threshold and task-based requirements to validate referrals in your campaign.
- [Leaderboard](https://docs.claimr.io/campaigns/leaderboard.md): Set up a public leaderboard to showcase top-performing participants and boost engagement with a competitive element.
- [Campaign sign-in options](https://docs.claimr.io/campaigns/campaign-sign-in-options.md): Configure login requirements, wallet behavior, sign-in services, and supported chains for your campaign.
- [Test users](https://docs.claimr.io/campaigns/test-users.md): Grant specific users test access to a campaign so your team can safely preview quests, tasks, and rewards without affecting live data.
- [Groups](https://docs.claimr.io/groups/overview.md): Use groups to organize Claimr campaigns, improving user experience, navigation, and overall campaign management.
- [Create new group](https://docs.claimr.io/groups/create-new-group.md): Build a new quest group in your campaign to organize related quests, then explore the group dashboard to add quests and manage tasks.
- [Group settings](https://docs.claimr.io/groups/group-settings.md): Configure general settings, time limits, tags, and advanced options for a quest group, and manage tasks across the group.
- [Quests](https://docs.claimr.io/quests/overview.md): Start building Claimr quests today and watch your community thrive — see what quests can do and where to start.
- [Create new quest](https://docs.claimr.io/quests/create-new-quest.md): Build engaging quest journeys that guide your users through rewarding experiences in your campaign.
- [Quest settings](https://docs.claimr.io/quests/quest-settings.md): Configure every aspect of your quest to create engaging experiences that align with your campaign goals.
- [Tasks](https://docs.claimr.io/tasks/overview.md): See what you can do with Claimr tasks and find your way into task creation, task settings, and every task type across social, Web3, forms, and more.
- [Create new task](https://docs.claimr.io/tasks/create-new-task.md): Add a new task to your quest, select the right type, and configure the core settings before customizing it further in the task-specific settings.
- [Task settings](https://docs.claimr.io/tasks/task-settings.md): Configure task info, general settings, rewards, completion pop-ups, dependencies, and advanced settings for any task type.
- [X (Twitter) tasks](https://docs.claimr.io/tasks/x-twitter-tasks.md): Increase your X presence, promote your content, and encourage meaningful interactions with Claimr's X (Twitter) task types.
- [Discord tasks](https://docs.claimr.io/tasks/discord-tasks.md): Leverage the power of Discord to grow your community and engage users within your Claimr campaigns.
- [TikTok tasks](https://docs.claimr.io/tasks/tiktok-tasks.md): Increase your brand's visibility, reach a wider audience, and encourage users to actively engage with your TikTok content by incorporating Claimr tasks.
- [YouTube tasks](https://docs.claimr.io/tasks/youtube-tasks.md): Incentivize users to subscribe to your channel or watch your videos, building a loyal community of viewers and subscribers.
- [Telegram tasks](https://docs.claimr.io/tasks/telegram-tasks.md): Connect with your community on Telegram, fostering engagement and growth with Claimr's Telegram task type.
- [Reddit tasks](https://docs.claimr.io/tasks/reddit-tasks.md): Reward users for upvoting Reddit posts, boosting visibility and directing attention to your campaigns and announcements.
- [LinkedIn tasks](https://docs.claimr.io/tasks/linkedin-tasks.md): Reward users for reposting your LinkedIn content directly from the feed, verified automatically through the LinkedIn embed.
- [Game tasks](https://docs.claimr.io/tasks/game-tasks.md): Reward users with randomized outcomes using Scratch Card and Fortune Wheel game tasks to boost retention and engagement.
- [Form tasks](https://docs.claimr.io/tasks/form-tasks.md): Set up and utilize Form tasks within your Claimr campaigns to collect user data, enhance engagement, and achieve your campaign objectives.
- [API tasks](https://docs.claimr.io/tasks/api-tasks.md): Connect your external application directly to Claimr's reward system and reward users for actions, values, or events that happen outside Claimr.
- [Web3 tasks](https://docs.claimr.io/tasks/web3-tasks/overview.md): Connect your Claimr campaigns to the blockchain and drive engagement through on-chain actions.
- [Connect a wallet](https://docs.claimr.io/tasks/web3-tasks/connect-a-wallet.md): Incentivize users to connect their cryptocurrency wallets to your Claimr campaign.
- [Transactions count](https://docs.claimr.io/tasks/web3-tasks/transactions-count.md): Verify and reward users based on the number of transactions they have made on a specific blockchain network.
- [Wallet balance](https://docs.claimr.io/tasks/web3-tasks/wallet-balance.md): Verify and reward users based on the balance they hold in their cryptocurrency wallet.
- [Token balance](https://docs.claimr.io/tasks/web3-tasks/token-balance.md): Verify and reward users based on the balance of a specific token they hold in their cryptocurrency wallet.
- [NFT balance](https://docs.claimr.io/tasks/web3-tasks/nft-balance.md): Verify and reward users based on the number of NFTs they hold in their cryptocurrency wallet.
- [Link3 balance](https://docs.claimr.io/tasks/web3-tasks/link3-balance.md): Verify and reward users based on their balance of Link3 tokens.
- [Mint an NFT (721)](https://docs.claimr.io/tasks/web3-tasks/mint-an-nft-721.md): Incentivize users to mint an NFT using the ERC-721 standard.
- [Mint an NFT (1155)](https://docs.claimr.io/tasks/web3-tasks/mint-an-nft-1155.md): Incentivize users to mint an NFT using the ERC-1155 standard.
- [Verify transactions](https://docs.claimr.io/tasks/web3-tasks/verify-transactions.md): Verify and reward users for executing a specific transaction on a selected blockchain network.
- [Anti-bot tasks](https://docs.claimr.io/tasks/anti-bot-tasks.md): Prevent automated submissions and ensure real users are interacting with your campaign using CAPTCHA verification and task dependencies.
- [UGC tasks](https://docs.claimr.io/tasks/ugc-tasks.md): Reward users for creating and sharing content across social platforms like X, TikTok, and YouTube.
- [PoW tasks](https://docs.claimr.io/tasks/pow-tasks.md): Verify user actions by requiring them to submit evidence of completion before earning rewards.
- [Common tasks](https://docs.claimr.io/tasks/common-tasks/overview.md): Flexible tasks for basic actions, onboarding steps, and manual interactions in your quests.
- [Block tasks](https://docs.claimr.io/tasks/common-tasks/block-tasks.md): Guide users through a simple action like clicking a button or copying text before they can continue.
- [Custom task](https://docs.claimr.io/tasks/common-tasks/custom-task.md): Require users to submit a text-based answer as verification of completing a task.
- [Poll tasks](https://docs.claimr.io/tasks/common-tasks/poll-tasks.md): Engage users by creating interactive polls within your Claimr campaigns.
- [Daily checkin](https://docs.claimr.io/tasks/common-tasks/daily-checkin.md): Reward users for returning to your quest day after day with configurable daily rewards.
- [Submit an email](https://docs.claimr.io/tasks/common-tasks/submit-an-email-tasks.md): Collect verified user emails by requiring participants to submit their email address and confirm it via a one-time code.
- [Referral tasks](https://docs.claimr.io/tasks/common-tasks/referral-tasks.md): Set up a referral task to supercharge your campaign's growth.
- [Visit a link](https://docs.claimr.io/tasks/common-tasks/visit-a-link-task.md): Reward users for simply clicking on a specified URL, with no proof or submission required.
- [HTTP request tasks](https://docs.claimr.io/tasks/common-tasks/http-request-tasks.md): Create Claimr tasks that utilize HTTP requests to interact with your own APIs for custom task completion logic.
- [SDK tasks](https://docs.claimr.io/tasks/sdk-tasks.md): Trigger task completion manually from your own system using Claimr's SDK for maximum developer flexibility.
- [Onchain tasks](https://docs.claimr.io/tasks/onchain-tasks.md): Track blockchain-based events directly in Claimr and automate rewards for verified on-chain activity without requiring API configuration.
- [Binance tasks](https://docs.claimr.io/tasks/bitcoin-tasks.md): Let users connect their Binance account to Claimr, verify KYC status, and calculate activity-based rewards from Binance data.
- [MEXC tasks](https://docs.claimr.io/tasks/mexc-tasks.md): Let users connect their MEXC account to Claimr, verify KYC status, and track trading volume directly from the exchange.
- [KuCoin tasks](https://docs.claimr.io/tasks/kucoin-tasks.md): Let users connect their KuCoin account to Claimr, verify KYC status, and track trading volume directly from the exchange.
- [Rewards](https://docs.claimr.io/rewards/overview.md): See what rewards can do for your campaigns and find your way into reward settings and custom rewards.
- [Reward settings](https://docs.claimr.io/rewards/reward-settings.md): Configure reward types, general settings, and type-specific fields for rewards attached to quests or managed independently.
- [Custom rewards](https://docs.claimr.io/rewards/custom-rewards.md): Use custom rewards to award points to users based on data you already have, outside of Claimr, via manual entry or CSV import.
- [Widget](https://docs.claimr.io/widget/overview.md): Discover everything you need to know about the Claimr widget, from basic setup to advanced integrations.
- [Publish campaign](https://docs.claimr.io/widget/publish-campaign.md): Publish your Claimr campaign, get the widget embed code, and go live to start engaging your audience.
- [Widget configurations](https://docs.claimr.io/widget/widget-configurations.md): Configure the Claimr widget to highlight specific components, adjust layouts, and personalize how quests, tasks, challenges, and leaderboards are displayed.
- [Widget attributes](https://docs.claimr.io/widget/widget-attributes.md): Reference every data-* attribute supported by the Claimr widget script, and learn how to use tags to personalize which quests and groups are shown.
- [Integrate the Claimr widget into your website](https://docs.claimr.io/widget/integrate-claimr-widget-into-your-website.md): Step-by-step instructions on how to embed the Claimr widget into your website, allowing you to seamlessly integrate interactive campaigns and quests into your web pages.
- [Widget themes](https://docs.claimr.io/widget/widget-themes.md): Use themes to match the Claimr widget to your brand, switch appearance automatically, and keep light and dark modes consistent with your product.
- [Claimr widget integrations](https://docs.claimr.io/widget/claimr-widget-integrations/overview.md): Integrate third-party marketing and analytics platforms with the Claimr widget to extend its functionality and gain insights into user behavior.
- [Google Analytics integration](https://docs.claimr.io/widget/claimr-widget-integrations/google-analytics-integration.md): Integrate the Claimr widget with Google Analytics 4 using the data-ga4 embed script attribute or a URL parameter.
- [Google Analytics Client ID](https://docs.claimr.io/widget/claimr-widget-integrations/google-analytics-client-id.md): Enhance your Claimr widget's Google Analytics integration by passing the GA4 Client ID for more accurate, cross-session user tracking.
- [Google Tag Manager integration](https://docs.claimr.io/widget/claimr-widget-integrations/google-tag-manager-integration.md): Use GTM to manage your Claimr tracking and other marketing tags without directly modifying your website's code.
- [Hotjar integration](https://docs.claimr.io/widget/claimr-widget-integrations/hotjar-integration.md): Integrate Hotjar with the Claimr widget by passing your Hotjar Site ID via a URL parameter to capture session recordings and heatmaps.
- [Webflow integration](https://docs.claimr.io/widget/claimr-widget-integrations/webflow-integration.md): Set up the HTML elements and script attributes needed to embed the Claimr widget into your Webflow site.
- [Framer integration](https://docs.claimr.io/widget/claimr-widget-integrations/framer-integration.md): Set up a frame and configure a Code Override to embed the Claimr widget into your Framer designs.
- [HTML integration](https://docs.claimr.io/widget/claimr-widget-integrations/html-integration.md): A short, structured instruction set for integrating the Claimr widget into a static HTML website.
- [Codes](https://docs.claimr.io/codes/overview.md): See how invite codes, secret codes, and gift codes each drive reach, engagement, and tracking in your Claimr campaigns.
- [Secret code tasks](https://docs.claimr.io/codes/secret-codes.md): Configure a secret code task, embed codes in your content, and see how the code entry field appears to users.
- [Invite codes](https://docs.claimr.io/codes/invite-codes/overview.md): Create, share, and manage invite codes, then attach them to Enter invite code and Claim invite code tasks.
- [Enter invite code task](https://docs.claimr.io/codes/invite-codes/enter-invite-code-task.md): Configure an Enter invite code task, select the required login platform, and preview how it appears to users.
- [Claim invite code task](https://docs.claimr.io/codes/invite-codes/claim-invite-code-task.md): Configure a Claim invite code task, set how many codes a user can claim, and preview how it appears before and after completion.
- [Gift codes](https://docs.claimr.io/codes/gift-codes.md): Create and manage gift code lists, then distribute them as rewards for completing tasks, quests, or campaigns.
- [Pop-ups](https://docs.claimr.io/pop-ups/overview.md): See what intro and completion pop-ups can do to onboard, guide, and celebrate progress with your campaign participants.
- [Intro pop-up](https://docs.claimr.io/pop-ups/into-pop-up.md): Build a custom form with Claimr's Forms feature, assign it as your campaign's intro pop-up, and preview the onboarding flow.
- [Completion pop-up](https://docs.claimr.io/pop-ups/completion-pop-up.md): Enable and design a completion pop-up for a group, quest, or task, and preview how it appears after a user succeeds.
- [Forms](https://docs.claimr.io/forms/overview.md): See what you can do with Claimr forms and find your way into creating forms, form settings, pages, blocks, and quizzes.
- [Create forms](https://docs.claimr.io/forms/create-forms.md): Access the forms section, create a new form, and learn how the forms table lets you sort and manage what you've built.
- [Form settings](https://docs.claimr.io/forms/form-settings.md): Rename your form, configure page pagination and legacy quiz mode, and set a minimum height to keep multi-page forms visually consistent.
- [Pages](https://docs.claimr.io/forms/pages.md): Add pages to your form and customize page settings to create visually appealing and user-friendly forms that match your brand.
- [Blocks](https://docs.claimr.io/forms/blocks.md): Explore every form block type — short answer, long answer, email, link, choice, quiz, rich text, video, and address — and their settings.
- [Quizzes](https://docs.claimr.io/forms/quizzes.md): Configure the Quiz block's questions, answer choices, scores, and explanations to engage users and test their knowledge.
- [Descriptions](https://docs.claimr.io/descriptions-creation-usage-tags.md): Learn how to format description fields across Claimr and use dynamic tags to personalize campaigns, quests, tasks, and forms for each participant.
- [Extra](https://docs.claimr.io/extra/overview.md): See what the Extra section offers — raffles, daily check-ins, challenges, ranks, KOLs, and tournaments — to keep users coming back for more.
- [Raffles](https://docs.claimr.io/extra/raffles.md): Configure raffle type, leaderboard source, eligibility requirements, and review winners and analytics for Claimr raffles.
- [Daily check-ins](https://docs.claimr.io/extra/daily-check-ins.md): Set up daily check-ins through the Events tab or as a quest task, configure the calendar display, customize per-day rewards, and see how check-ins appear to users.
- [Challenges](https://docs.claimr.io/extra/challenges.md): Configure challenge type, requirements, and rewards, and see how challenge tiles appear and update for users.
- [Ranks](https://docs.claimr.io/extra/ranks.md): Configure rank tiers, point thresholds, and rewards, and see how ranks and progress bars appear to users.
- [KOLs](https://docs.claimr.io/extra/kols.md): Set up KOL entries with unique referral links and track referral performance metrics like valid referrals, total referrals, and XP earned.
- [Tournaments](https://docs.claimr.io/extra/tournaments.md): Configure tournament requirements and point types, manage tournament status, and review tournament analytics and the user-facing leaderboard tab.
- [Data analytics](https://docs.claimr.io/data-analytics/overview.md): See what you can do with Claimr analytics and find your way into activity, referrals, UGC, PoW, user information, failed actions, and issues.
- [Activity](https://docs.claimr.io/data-analytics/activity.md): See a detailed overview of all user actions within your campaign, export activity data, and explore the full Activity table columns.
- [Referrals analytics](https://docs.claimr.io/data-analytics/referrals.md): Monitor referrers and referred users, export referral data, and understand how verified and unverified referral statuses are determined.
- [UGC analytics](https://docs.claimr.io/data-analytics/ugc-analytics.md): Review, approve, reject, and rate user-generated content submitted through UGC tasks in your campaign.
- [PoW analytics](https://docs.claimr.io/data-analytics/pow-analytics.md): Review, approve, reject, filter, and export Proof of Work task submissions to ensure the integrity of your campaign.
- [User information](https://docs.claimr.io/data-analytics/user-information.md): Open a user's detail modal to see their general info, UTM data, points, quests, tasks, rewards, referrals, transactions, and account actions.
- [Failed actions](https://docs.claimr.io/data-analytics/failed-actions.md): See a log-by-task and log-by-user breakdown of actions users attempted that resulted in failure, to improve task clarity and user flow.
- [Issues analytics](https://docs.claimr.io/data-analytics/issues-analytics.md): Review user-reported task completion issues and drill into each report's general, task, reporter, and trace details.
- [Usage Data](https://docs.claimr.io/usage-data.md): See detailed breakdowns, projections, and historical records of your subscription performance, connected directly to the values shown in Billing.
- [Team roles and management](https://docs.claimr.io/team-roles-and-management.md): The Team Management panel allows you to view and manage team members, their roles, and permissions. You can also invite new members to join your team and remove existing ones.
- [Billing](https://docs.claimr.io/billing.md): See the details of your active subscription, understand Claimr's credits-based pricing model, and review your history of past subscriptions.
- [Localization](https://docs.claimr.io/localization.md): Add languages to your campaign, create custom localization keys, and localize rich text descriptions so users see content in their own language.
- [API](https://docs.claimr.io/api-guide/overview.md): See what you can do with the Claimr API — retrieve user information, check balances, monitor activity, and subscribe to webhooks.
- [API token](https://docs.claimr.io/api-guide/api-token.md): Generate your organization's API token and use it to authorize requests to the Claimr API.
- [API methods](https://docs.claimr.io/api-guide/api-methods.md): A conceptual guide to Claimr's API methods, organized by category. For exact parameters, request bodies, and live testing, use the API Playground.
- [User token](https://docs.claimr.io/api-guide/user-token.md): Integrate user tokens to seamlessly track user progress within your campaigns without asking users to log in separately.
- [Public API](https://docs.claimr.io/api-guide/public-api.md): Generate a Public token to read campaign and user statistics directly from your frontend with read-only GET endpoints.
- [Webhooks](https://docs.claimr.io/webhooks-guide/overview.md): Learn how Claimr webhooks deliver real-time updates to your applications, enhancing efficiency and user engagement.
- [Set up webhooks](https://docs.claimr.io/webhooks-guide/set-up-webhooks.md): Step-by-step guide on registering, configuring, and testing webhooks in Claimr, including secret keys, payloads, and retry policy.
- [Assign webhooks](https://docs.claimr.io/webhooks-guide/assign-webhooks.md): Assign Claimr's pre-defined webhooks to your applications, configure their settings, and test the integration before going live.
- [Webhook scopes](https://docs.claimr.io/webhooks-guide/webhook-scopes.md): Explanation of the different webhook scopes in Claimr and the events they cover, so your application only receives relevant updates.
- [SDK](https://docs.claimr.io/sdk-guide.md): Use the Claimr SDK to integrate Claimr into your web application, customize its behavior, and create a more engaging and rewarding user experience.
- [Integrate Claimr widget into your dApp](https://docs.claimr.io/how-to/integrate-claimr-widget-into-dapp.md): Use this tutorial to integrate the Claimr widget with a custom wallet connection in your dApp, including anonymous or privacy-preserving wallet setups.
- [Integrate Claimr widget into a Telegram mini app](https://docs.claimr.io/how-to/integrating-claimr-widget-into-telegram-mini-app.md): Integrate the Claimr widget into your Telegram Mini App to leverage Claimr's engagement features while automatically using the user's Telegram context.
- [Add custom points to users](https://docs.claimr.io/how-to/add-custom-points-to-users.md): Use Claimr's API endpoints to reward users for actions they complete outside the platform, syncing off-platform activity with your Claimr reward system.
- [Set Webhook](https://docs.claimr.io/api-reference/webhooks/set-webhook.md)
- [Remove Webhook](https://docs.claimr.io/api-reference/webhooks/remove-webhook.md)
- [Get User Token](https://docs.claimr.io/api-reference/user-token/get-user-token.md): Creates or retrieves a user token for authentication. The user will be registered if they don't exist. Platform 'claimr' is not allowed.
- [Get Referral ID](https://docs.claimr.io/api-reference/user/get-referral-id.md): Gets or creates a referral ID for a user in a specific campaign. If the user doesn't have a campaign entry, one will be created. If no referral link exists, a new one will be generated.
- [Set Referrer ID](https://docs.claimr.io/api-reference/user/set-referrer-id.md): Associates a user with a referrer in a specific campaign. Creates campaign entry if needed. Only works if the user has no existing referrer and no completed tasks. The referral link must exist and not be self-referential.
- [Update User Profile](https://docs.claimr.io/api-reference/user/update-user-profile.md): Updates user's name / alias / team. Creates campaign entry if needed.
- [Set Referrer](https://docs.claimr.io/api-reference/user/set-referrer.md): Creates a referral relationship between a referrer and a referral user in a specific campaign. Both users will be registered if they don't exist, and campaign entries will be created as needed. The referral user must not have an existing referrer or completed tasks.
- [Get XP Balance](https://docs.claimr.io/api-reference/user/get-xp-balance.md)
- [Get User Activity](https://docs.claimr.io/api-reference/user/get-user-activity.md)
- [Get User Progress](https://docs.claimr.io/api-reference/user/get-user-progress.md)
- [Get User Profiles](https://docs.claimr.io/api-reference/user/get-user-profiles.md)
- [Get Referral Data](https://docs.claimr.io/api-reference/user/get-referral-data.md)
- [Award XP Reward](https://docs.claimr.io/api-reference/user/award-xp-reward.md): Creates an API-type reward for a user, adds the specified XP, and triggers XP processing. If the user doesn't exist in the campaign and uses a valid web3 address, a new entry will be created. Prevents duplicate rewards with the same ID.
- [Withdraw User Points](https://docs.claimr.io/api-reference/user/withdraw-user-points.md): Creates a withdrawal record for a user's earned points in a specific campaign. Validates user existence, campaign bundle, and optionally checks balance before processing.
- [Set Task Value](https://docs.claimr.io/api-reference/tasks/set-task-value.md): Records an task with a specific value for a user within a campaign quest. Validates user login, campaign bundle, and quest group before executing the task.
- [Push Stream Value](https://docs.claimr.io/api-reference/tasks/push-stream-value.md): Pushes a value to all API stream tasks within a campaign that match the specified stream name. Automatically finds and triggers all quests/tasks configured for the given stream across all campaign schemes and groups.
- [Get Custom Events](https://docs.claimr.io/api-reference/events/get-custom-events.md): Get custom events associated with a user for tracking and triggering downstream processes. Events are stored with optional categorization and custom data payload. Results can be filtered by category and name.
- [Push Custom Event](https://docs.claimr.io/api-reference/events/push-custom-event.md): Creates a custom event record associated with a user for tracking, and triggering downstream processes. Events are stored with optional categorization and custom data payload.
- [Get Campaign Info](https://docs.claimr.io/api-reference/campaign/get-campaign-info.md): Retrieves comprehensive campaign data including all tasks, quests, their properties, dependencies, and reward structures. Supports both published and development environments.
- [Get Campaign Points](https://docs.claimr.io/api-reference/campaign/get-campaign-points.md): Retrieves campaign statistics including total points earned, current season points, season index, and current season details. Calculates season progression based on configured season thresholds.
- [Get Campaign Stats](https://docs.claimr.io/api-reference/campaign/get-campaign-stats.md): Retrieves detailed campaign statistics including total points awarded, user participation metrics, and complete stats object for analytics and reporting purposes.
- [Get Invite Code Status](https://docs.claimr.io/api-reference/invite-codes/get-invite-code-status.md): Retrieves information about an invite code including which users have used it.
- [Use Invite Code](https://docs.claimr.io/api-reference/invite-codes/use-invite-code.md): Assigns an invite code to a user (identified by wallet address). This endpoint handles user registration if the address is new, creates campaign entries, and marks the invite code as used.
- [Release Invite Code](https://docs.claimr.io/api-reference/invite-codes/release-invite-code.md): Releases an invite code that was previously assigned to a user, making it available for use again. The used_by parameter is optional and can be used to specify which user to release the code from.
- [Get Wallet Invite Code](https://docs.claimr.io/api-reference/wallets/get-wallet-invite-code.md): Retrieves the invite code that was used by a wallet address for a specific campaign. Returns an empty string if no invite code was used or if the wallet/campaign combination is not found.
- [Get Wallet Referral ID](https://docs.claimr.io/api-reference/wallets/get-wallet-referral-id.md): Retrieves the referral ID associated with a wallet address for a given campaign. Returns an error if the wallet is not found or has no referral ID for the specified campaign.
- [Award Wallet XP](https://docs.claimr.io/api-reference/wallets/award-wallet-xp.md): Awards XP points to a wallet address for a campaign. This endpoint handles user registration if the address is new, creates campaign entries, validates reward uniqueness, and processes XP calculations. Also triggers webhook notifications for the reward event.
- [Withdraw Wallet Points](https://docs.claimr.io/api-reference/wallets/withdraw-wallet-points.md): Withdraws XP points from a wallet address for a campaign. This endpoint handles user registration if the address is new, creates campaign entries, validates withdrawal uniqueness, and optionally verifies sufficient balance before withdrawal. Processes XP calculations after withdrawal.
- [Get Leaderboard](https://docs.claimr.io/api-reference/leaderboard/get-leaderboard.md): Retrieves leaderboard data for a specific campaign. Supports both v1 and v2 leaderboard formats based on campaign type.
- [How to](https://docs.claimr.io/how-to/overview.md): Follow step-by-step tutorials to build platform-specific campaigns, integrate the Claimr widget, and unlock advanced features like tags, custom points, and puzzle rewards.
- [Create X campaign](https://docs.claimr.io/how-to/create-x-campaign.md): Follow this tutorial to create your X (Twitter) campaign in Claimr, from initial setup through configuring the most popular X tasks.
- [Create Discord campaign](https://docs.claimr.io/how-to/create-discord-campaign.md): Follow this tutorial to create your Discord campaign in Claimr, covering all steps from initial setup through configuring Discord-specific tasks.
- [Customize user experience with tags and attributes](https://docs.claimr.io/how-to/customize-user-experience-with-tags-and-attributes.md): Use tags in Claimr campaign settings together with widget data-attributes to dynamically show or hide Quests and Groups for different user segments.
- [Build a campaign with Puzzle rewards](https://docs.claimr.io/how-to/how-to-build-a-campaign-with-puzzle-rewards.md): Build a campaign that uses Puzzle rewards, from puzzle piece reward creation to task logic and final answer validation.
- [UX requirements](https://docs.claimr.io/ux-requirements/overview.md): Design checklists covering campaign structure, groups, quest cards, quests, tasks, user progress, pop-ups, and interactive components in Claimr.
- [Campaign UX requirements](https://docs.claimr.io/ux-requirements/campaign-ux-requirements.md): Key design elements and considerations for building visually appealing, user-friendly Claimr campaigns, from user progress to leaderboards.
- [Group UX requirements](https://docs.claimr.io/ux-requirements/group-ux-requirements.md): UX design considerations for presenting groups of quests within your Claimr campaigns, including state indicators and layout options.
- [Quest card UX requirements](https://docs.claimr.io/ux-requirements/quest-card-ux-requirements.md): Key design elements and considerations for creating effective and engaging quest cards in your Claimr campaigns.
- [Quest UX requirements](https://docs.claimr.io/ux-requirements/quest-ux-requirements.md): Key design elements and considerations for building visually appealing and user-friendly Claimr quests, from the header to the footer.
- [Task UX requirements](https://docs.claimr.io/ux-requirements/task-ux-requirements.md): UX design requirements for presenting tasks within your Claimr quests, covering active, locked, completed, and pending states plus popular task types.
- [User progress UX requirements](https://docs.claimr.io/ux-requirements/user-progress-ux-requirements.md): How to design clear and informative displays of user progress within Claimr, covering the logged-in and logged-out states and what to include in each.
- [Pop-ups UX requirements](https://docs.claimr.io/ux-requirements/pop-ups-ux-requirements.md): UX design requirements for pop-ups within your Claimr campaigns, covering login, wallet connect, task completion, challenges, leaderboard, and notifications.
- [Interactive components UX requirements](https://docs.claimr.io/ux-requirements/interactive-components-ux-requirements.md): UX design requirements for buttons and input fields within your Claimr campaigns, ensuring they are user-friendly, accessible, and visually appealing.

## OpenAPI Specs

- [openapi](https://docs.claimr.io/openapi.yaml)