# Trophy Docs

## Docs

- [Billing](https://trophy-mintlify-3a28412f.mintlify.app/account/billing.md): Understand Trophy's billing model based on monthly active users, view available plans, manage your subscription, and control gamification costs.
- [Branding](https://trophy-mintlify-3a28412f.mintlify.app/account/branding.md): Configure your logo, brand colors, and visual styling so Trophy emails, push notifications, and UI components match your product brand.
- [Members](https://trophy-mintlify-3a28412f.mintlify.app/account/members.md): Invite teammates to your Trophy account, manage their roles and permissions, and control who can edit metrics, achievements, and other settings.
- [Account overview](https://trophy-mintlify-3a28412f.mintlify.app/account/overview.md): Manage your Trophy account, including team members, billing, branding, and account-level settings used across the Trophy platform.
- [Admin API authentication](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/authentication.md): Authenticate Admin API requests using account-level API keys sent in the X-API-KEY header to manage Trophy configuration programmatically.
- [Admin API client libraries](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/client-libraries.md): Install Trophy's type-safe SDKs for Node.js, Python, and other languages to integrate the Admin API and automate configuration workflows.
- [Create attributes](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/attributes/create-attributes.md): Create attributes.
- [Delete attributes](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/attributes/delete-attributes.md): Delete attributes by ID.
- [Get an attribute](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/attributes/get-an-attribute.md): Get an attribute by ID.
- [List attributes](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/attributes/list-attributes.md): List attributes.
- [Update attributes](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/attributes/update-attributes.md): Update attributes by ID.
- [Create leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/leaderboards/create-leaderboards.md): Create leaderboards. Maximum 100 leaderboards per request.
- [Delete leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/leaderboards/delete-leaderboards.md): Delete leaderboards by ID.
- [Get a leaderboard](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/leaderboards/get-a-leaderboard.md): Get a leaderboard by ID.
- [List leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/leaderboards/list-leaderboards.md): List leaderboards.
- [Update leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/leaderboards/update-leaderboards.md): Update leaderboards by ID. Updating `status` behaves the same as activating, scheduling, deactivating, or finishing a leaderboard in the dashboard.
- [Create metrics](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/metrics/create-metrics.md): Create metrics.
- [Delete metrics](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/metrics/delete-metrics.md): Delete metrics by ID.
- [Get a metric by ID](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/metrics/get-a-metric.md): Get a metric by ID.
- [List metrics](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/metrics/list-metrics.md): List metrics.
- [Update metrics](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/metrics/update-metrics.md): Update metrics by ID.
- [Create points boosts](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/create-boosts.md): Create points boosts.
- [Create points levels](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/create-levels.md): Create points levels. Maximum 100 levels per request.
- [Create points systems](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/create-points-systems.md): Create points systems. Optionally include sub-entities (levels, boosts, triggers) in each system payload to create them alongside the system.
- [Create points triggers](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/create-points-triggers.md): Create points triggers in bulk. Maximum 100 triggers per request.
- [Delete multiple points boosts](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/delete-boosts.md): Delete multiple points boosts by ID.
- [Delete multiple points levels](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/delete-levels.md): Delete multiple points levels by ID.
- [Delete points systems](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/delete-points-systems.md): Delete (archive) points systems by ID.
- [Delete points triggers](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/delete-points-triggers.md): Delete (archive) points triggers by ID. Maximum 100 trigger IDs per request.
- [Get a points boost by ID](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/get-a-boost.md): Get a single points boost by ID.
- [Get a points level by ID](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/get-a-level.md): Get a single points level by ID.
- [Get a points system by ID](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/get-a-points-system.md): Get a points system by ID.
- [Get a points trigger by ID](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/get-a-points-trigger.md): Get a single points trigger by ID.
- [List points boosts](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/list-boosts.md): List points boosts for a system.
- [List points levels](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/list-levels.md): List points levels for a system.
- [List points systems](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/list-points-systems.md): List points systems.
- [List points triggers](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/list-points-triggers.md): List points triggers for a system.
- [Update multiple points boosts](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/update-boosts.md): Update multiple points boosts.
- [Update multiple points levels](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/update-levels.md): Update multiple points levels. Each item must include an ID. `key` cannot be changed.
- [Update points systems](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/update-points-systems.md): Update points systems by ID.
- [Update points triggers](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/points/update-points-triggers.md): Update points triggers in bulk. Maximum 100 triggers per request. Only provided fields are updated; omitted fields are preserved.
- [Create streak freezes for multiple users](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/streaks/grant-freezes.md): Create streak freezes for multiple users.
- [Restore streaks for multiple users](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/streaks/restore-streaks.md): Restore streaks for multiple users to the maximum previously achieved streak length found within the current restore window: the last 90 days for daily streaks, weekly periods starting with the week containing the start of the current calendar year for weekly streaks, and monthly periods starting at…
- [Create tenants](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/tenants/create-tenants.md): Create tenants.
- [Delete tenants](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/tenants/delete-tenants.md): Delete tenants by ID.
- [Get a tenant](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/tenants/get-a-tenant.md): Get a tenant by ID.
- [List tenants](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/tenants/list-tenants.md): List tenants in the current environment.
- [Update tenants](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/endpoints/tenants/update-tenants.md): Update tenants by ID.
- [Admin API introduction](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/introduction.md): Use the Trophy Admin API to manage metrics, achievements, leaderboards, points, and other gamification configuration through code.
- [Admin API rate limiting](https://trophy-mintlify-3a28412f.mintlify.app/admin-api/rate-limiting.md): Understand the request rate limits applied to Trophy Admin API endpoints, the response headers returned, and how to handle 429 errors.
- [Application API authentication](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/authentication.md): Authenticate Application API requests with account-level API keys sent in the X-API-KEY header to power in-app gamification features.
- [Application API client libraries](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/client-libraries.md): Install Trophy's type-safe SDKs for Node.js, Python, and other languages to integrate the Application API and build gamification features.
- [Get all achievements and their completion stats](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/achievements/all-achievements.md): Get all achievements and their completion stats.
- [Mark an achievement as completed](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/achievements/mark-an-achievement-as-completed.md): Mark an achievement as completed for a user.
- [Get all leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/leaderboards/get-all-active-leaderboards.md): Get all leaderboards for your organization. Finished leaderboards are excluded by default.
- [Get a single leaderboard](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/leaderboards/get-leaderboard.md): Get a specific leaderboard by its key.
- [Send a metric change event](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/metrics/send-a-metric-change-event.md): Increment or decrement the value of a metric for a user.
- [Get a points system with its triggers](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/points/get-points.md): Get a points system with its triggers.
- [Get boosts for a points system](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/points/get-points-boosts.md): Get all global boosts for a points system. Finished boosts are excluded by default.
- [Get level summary for a points system](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/points/get-points-level-summary.md): Get a breakdown of the number of users at each level in a points system.
- [Get levels for a points system](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/points/get-points-levels.md): Get all levels for a points system.
- [Get a breakdown of users by points](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/points/get-points-summary.md): Get a breakdown of the number of users with points in each range.
- [Get top users by streak length](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/streaks/get-streak-rankings.md): Get the top users by streak length (active or longest).
- [Get the streak lengths of a list of users](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/streaks/get-streaks.md): Get the streak lengths of a list of users, ranked by streak length from longest to shortest.
- [Create a new user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/create-a-user.md): Create a new user.
- [Get a summary of metric events over time](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-single-metric-event-summary-for-a-user.md): Get a summary of metric events over time for a user.
- [Get a single metric for a user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-single-metric-for-a-user.md): Get a user's progress against a single active metric.
- [Get a single user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-single-user.md): Get a single user.
- [Get a user's achievements](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-completed-achievements.md): Get a user's achievements.
- [Get a user's leaderboard data](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-leaderboard.md): Get a user's rank, value, and history for a specific leaderboard.
- [Get a user's points data](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-points.md): Get a user's points for a specific points system.
- [Get a user's active points boosts](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-points-boosts.md): Get active points boosts for a user in a specific points system. Returns both global boosts the user is eligible for and user-specific boosts.
- [Get a summary of points events over time](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-points-summary.md): Get a summary of points awards over time for a user for a specific points system.
- [Get a user's streak status](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-streak.md): Get a user's streak data.
- [Get a user's wrapped data](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-a-users-wrapped.md): Get a user's year-in-review wrapped data.
- [Get all metrics for a user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-all-metrics-for-a-user.md): Get a single user's progress against all active metrics.
- [Get a user's preferences](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/get-user-preferences.md): Get a user's notification preferences.
- [Identify a user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/identify-a-user.md): Identify a user.
- [Update a user](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/update-a-user.md): Update a user.
- [Update a user's preferences](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/endpoints/users/update-user-preferences.md): Update a user's notification preferences.
- [API idempotency](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/idempotency.md): Safely retry Trophy API requests using the Idempotency-Key header to prevent duplicate event tracking and unintended side effects on retries.
- [Application API introduction](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/introduction.md): Use the Trophy Application API to track user events, complete achievements, query streaks, and power gamification features in your app.
- [Application API rate limiting](https://trophy-mintlify-3a28412f.mintlify.app/api-reference/rate-limiting.md): Understand the request rate limits applied to Trophy Application API endpoints, the response headers returned, and how to handle 429 errors.
- [Achievements](https://trophy-mintlify-3a28412f.mintlify.app/features/achievements.md): Reward users with metric, API, streak, and composite achievements that recognize progress, drive feature discovery, and boost retention.
- [Emails](https://trophy-mintlify-3a28412f.mintlify.app/features/emails.md): Send automated gamification emails for achievements, streaks, and points to re-engage users and drive retention without writing email code.
- [Events](https://trophy-mintlify-3a28412f.mintlify.app/features/events.md): Track individual user interactions in Trophy by sending metric events that drive achievements, streaks, points, and leaderboard rankings.
- [Leaderboards](https://trophy-mintlify-3a28412f.mintlify.app/features/leaderboards.md): Run daily, weekly, or monthly leaderboards that rank users by metrics, points, or streaks to drive competition and engagement in your app.
- [Metrics](https://trophy-mintlify-3a28412f.mintlify.app/features/metrics.md): Model any user interaction with Trophy metrics, the flexible primitive that powers achievements, streaks, points, and leaderboards.
- [Trophy features overview](https://trophy-mintlify-3a28412f.mintlify.app/features/overview.md): Learn the key concepts behind Trophy's gamification system, including metrics, events, achievements, streaks, points, and leaderboards.
- [Points](https://trophy-mintlify-3a28412f.mintlify.app/features/points.md): Build points systems with triggers, levels, and boosts to reward users for in-app actions and create XP-style progression in your product.
- [Push notifications](https://trophy-mintlify-3a28412f.mintlify.app/features/push-notifications.md): Send automated push notifications for achievements, streaks, and points to bring users back to your mobile app and increase engagement.
- [Streaks](https://trophy-mintlify-3a28412f.mintlify.app/features/streaks.md): Build daily, weekly, or monthly streaks with freezes and restorations to drive habit formation and keep users returning to your app.
- [Users](https://trophy-mintlify-3a28412f.mintlify.app/features/users.md): Identify and track users in Trophy, sync attributes from your app, and unify their gamification activity across metrics, points, and streaks.
- [Welcome to Trophy](https://trophy-mintlify-3a28412f.mintlify.app/getting-started/introduction.md): Trophy is a developer toolkit for adding achievements, streaks, points, and leaderboards to web and mobile apps with a few lines of code.
- [Trophy quick start](https://trophy-mintlify-3a28412f.mintlify.app/getting-started/quickstart.md): Integrate Trophy into your backend in under 10 minutes and start tracking events, completing achievements, and powering gamified features.
- [How to build a gamified fitness tracker](https://trophy-mintlify-3a28412f.mintlify.app/guides/gamified-fitness-platform.md): Build a Strava-like fitness tracker with Next.js and Trophy, featuring multi-sport tracking, city-based leaderboards, streaks, and XP progression.
- [Environments](https://trophy-mintlify-3a28412f.mintlify.app/platform/environments.md): Use Trophy environments to isolate gamification data, test configuration changes safely, and promote updates from development to production.
- [Experimentation](https://trophy-mintlify-3a28412f.mintlify.app/platform/experimentation.md): Run A/B tests on Trophy gamification features using control flags and audience targeting to measure the impact on retention and engagement.
- [Multi-tenancy](https://trophy-mintlify-3a28412f.mintlify.app/platform/multi-tenancy.md): Use Trophy multi-tenancy to configure and customize gamification features per customer or workspace from one shared Trophy account.
- [Platform overview](https://trophy-mintlify-3a28412f.mintlify.app/platform/overview.md): Configure and operate the Trophy platform with environments, multi-tenancy, and experimentation tools to ship gamification features safely.
- [Gamification UI Kit](https://trophy-mintlify-3a28412f.mintlify.app/uikit/overview.md): Drop in prebuilt Trophy UI components for achievements, streaks, points, and leaderboards to add polished gamification screens to your app.
- [Achievement completed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/achievements/achievement-completed.md): Triggered when a user completes an achievement.
- [Leaderboard changed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/leaderboards/leaderboard-changed.md): Triggered when leaderboard rankings change.
- [Leaderboard finished](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/leaderboards/leaderboard-finished.md): Triggered when a run of a leaderboard finishes.
- [Leaderboard rank changed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/leaderboards/leaderboard-rank-changed.md): Triggered when a user's leaderboard rank changes.
- [Leaderboard started](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/leaderboards/leaderboard-started.md): Triggered when a run of a leaderboard begins.
- [Points boost finished](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/points/points-boost-finished.md): Triggered when a points boost ends (its end time has been reached).
- [Points boost started](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/points/points-boost-started.md): Triggered when a points boost goes live (its start time has been reached).
- [Points changed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/points/points-changed.md): Triggered when a user is awarded or loses points. This event is fired a maximum of once per user per points system per minute.
- [Points level changed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/points/points-level-changed.md): Triggered when a user's level changes within a points system as a result of earning or losing points.
- [Streak extended](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/streaks/streak-extended.md): Triggered when a user extends an existing active streak.
- [Streak freeze consumed](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/streaks/streak-freeze-consumed.md): Triggered when a user consumes a streak freeze.
- [Streak freeze earned](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/streaks/streak-freeze-earned.md): Triggered when a user earns streak freezes.
- [Streak lost](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/streaks/streak-lost.md): Triggered when a user loses their streak.
- [Streak started](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/events/streaks/streak-started.md): Triggered when a user starts a streak.
- [Webhook idempotency](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/idempotency.md): Ensure your webhook endpoints process each Trophy event exactly once by deduplicating delivery attempts using the event ID header.
- [Webhooks introduction](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/introduction.md): Subscribe to Trophy webhook events to react to achievement completions, streak changes, points updates, and other gamification activity.
- [Observability](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/observability.md): Monitor Trophy webhook delivery, inspect event payloads, and diagnose failed deliveries using built-in dashboard analytics and event logs.
- [Webhooks quick start](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/quickstart.md): Configure a Trophy webhook endpoint and start receiving real-time events for achievements, streaks, points, and leaderboards in 10 minutes.
- [Retries](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/retries.md): Understand how Trophy retries failed webhook deliveries with exponential backoff after timeouts, network errors, and non-2XX HTTP responses.
- [Security](https://trophy-mintlify-3a28412f.mintlify.app/webhooks/security.md): Secure your Trophy webhook endpoints by verifying the X-Trophy-Signature header so only authentic events from Trophy are processed.

## OpenAPI Specs

- [application](https://trophy-mintlify-3a28412f.mintlify.app/openapi/application.yml)
- [admin](https://trophy-mintlify-3a28412f.mintlify.app/openapi/admin.yml)

## Optional

- [GitHub](https://github.com/trophyso)
- [Status](https://status.trophy.so)
- [llms.txt](https://docs.trophy.so/llms-full.txt)
- [Help](mailto:support@trophy.so)
- [GitHub](https://github.com/trophyso)
- [Estado](https://status.trophy.so)
- [llms.txt](https://docs.trophy.so/llms-full.txt)
- [Ayuda](mailto:support@trophy.so)