# Trophy Docs

## Docs

- [Billing](https://trophy-mintlify-b0666975.mintlify.app/account/billing.md): Understand Trophy's usage-based pricing model based on monthly active users, plan tiers, free quotas, and how to manage your subscription.
- [Branding](https://trophy-mintlify-b0666975.mintlify.app/account/branding.md): Configure your organization's logo, brand colors, and visual identity used across Trophy emails, push notifications, and gamified experiences.
- [Members](https://trophy-mintlify-b0666975.mintlify.app/account/members.md): Invite teammates to your Trophy organization, manage member roles and permissions, and control access to your gamification dashboard.
- [Overview](https://trophy-mintlify-b0666975.mintlify.app/account/overview.md): Manage your Trophy organization including team members, billing details, branding, and other account-level settings from the Trophy dashboard.
- [Authentication](https://trophy-mintlify-b0666975.mintlify.app/admin-api/authentication.md): Authenticate Trophy Admin API requests securely using account-level API keys transmitted in the X-API-KEY header from your server.
- [Client Libraries](https://trophy-mintlify-b0666975.mintlify.app/admin-api/client-libraries.md): Use Trophy's type-safe SDKs in Node.js, Python, Go, Ruby, and more to call Admin API endpoints through the trophy.admin client namespace.
- [Create attributes](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/attributes/create-attributes.md): Create attributes.
- [Delete attributes](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/attributes/delete-attributes.md): Delete attributes by ID.
- [Get an attribute](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/attributes/get-an-attribute.md): Get an attribute by ID.
- [List attributes](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/attributes/list-attributes.md): List attributes.
- [Update attributes](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/attributes/update-attributes.md): Update attributes by ID.
- [Create leaderboards](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/leaderboards/create-leaderboards.md): Create leaderboards. Maximum 100 leaderboards per request.
- [Delete leaderboards](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/leaderboards/delete-leaderboards.md): Delete leaderboards by ID.
- [Get a leaderboard](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/leaderboards/get-a-leaderboard.md): Get a leaderboard by ID.
- [List leaderboards](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/leaderboards/list-leaderboards.md): List leaderboards.
- [Update leaderboards](https://trophy-mintlify-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/metrics/create-metrics.md): Create metrics.
- [Delete metrics](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/metrics/delete-metrics.md): Delete metrics by ID.
- [Get a metric by ID](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/metrics/get-a-metric.md): Get a metric by ID.
- [List metrics](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/metrics/list-metrics.md): List metrics.
- [Update metrics](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/metrics/update-metrics.md): Update metrics by ID.
- [Create points boosts](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/create-boosts.md): Create points boosts.
- [Create points levels](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/create-levels.md): Create points levels. Maximum 100 levels per request.
- [Create points systems](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/points/delete-boosts.md): Delete multiple points boosts by ID.
- [Delete multiple points levels](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/delete-levels.md): Delete multiple points levels by ID.
- [Delete points systems](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/delete-points-systems.md): Delete (archive) points systems by ID.
- [Delete points triggers](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/points/get-a-points-trigger.md): Get a single points trigger by ID.
- [List points boosts](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/list-boosts.md): List points boosts for a system.
- [List points levels](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/list-levels.md): List points levels for a system.
- [List points systems](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/list-points-systems.md): List points systems.
- [List points triggers](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/list-points-triggers.md): List points triggers for a system.
- [Update multiple points boosts](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/points/update-boosts.md): Update multiple points boosts.
- [Update multiple points levels](https://trophy-mintlify-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/points/update-points-systems.md): Update points systems by ID.
- [Update points triggers](https://trophy-mintlify-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/streaks/grant-freezes.md): Create streak freezes for multiple users.
- [Restore streaks for multiple users](https://trophy-mintlify-b0666975.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-b0666975.mintlify.app/admin-api/endpoints/tenants/create-tenants.md): Create tenants.
- [Delete tenants](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/tenants/delete-tenants.md): Delete tenants by ID.
- [Get a tenant](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/tenants/get-a-tenant.md): Get a tenant by ID.
- [List tenants](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/tenants/list-tenants.md): List tenants in the current environment.
- [Update tenants](https://trophy-mintlify-b0666975.mintlify.app/admin-api/endpoints/tenants/update-tenants.md): Update tenants by ID.
- [Introduction](https://trophy-mintlify-b0666975.mintlify.app/admin-api/introduction.md): Drive custom gamification workflows using the Trophy Admin API to manage metrics, achievements, leaderboards, and points programmatically.
- [Rate Limiting](https://trophy-mintlify-b0666975.mintlify.app/admin-api/rate-limiting.md): Learn the Trophy Admin API rate limits, tiered request quotas, and how to handle 429 responses when integrating administrative workflows.
- [Authentication](https://trophy-mintlify-b0666975.mintlify.app/api-reference/authentication.md): Authenticate Trophy Application API requests securely from your backend using account-level API keys sent in the X-API-KEY header.
- [Client Libraries](https://trophy-mintlify-b0666975.mintlify.app/api-reference/client-libraries.md): Integrate the Trophy Application API using official SDKs available in Node.js, Python, Go, Ruby, Java, and PHP for type-safe gamification.
- [Get all achievements and their completion stats](https://trophy-mintlify-b0666975.mintlify.app/api-reference/endpoints/achievements/all-achievements.md): Get all achievements and their completion stats.
- [Mark an achievement as completed](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.mintlify.app/api-reference/endpoints/leaderboards/get-leaderboard.md): Get a specific leaderboard by its key.
- [Send a metric change event](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.mintlify.app/api-reference/endpoints/users/get-a-single-user.md): Get a single user.
- [Get a user's achievements](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.mintlify.app/api-reference/endpoints/users/get-user-preferences.md): Get a user's notification preferences.
- [Identify a user](https://trophy-mintlify-b0666975.mintlify.app/api-reference/endpoints/users/identify-a-user.md): Identify a user.
- [Update a user](https://trophy-mintlify-b0666975.mintlify.app/api-reference/endpoints/users/update-a-user.md): Update a user.
- [Update a user's preferences](https://trophy-mintlify-b0666975.mintlify.app/api-reference/endpoints/users/update-user-preferences.md): Update a user's notification preferences.
- [Idempotency](https://trophy-mintlify-b0666975.mintlify.app/api-reference/idempotency.md): Use the Idempotency-Key header and built-in SDK controls to safely retry Trophy API requests without double-counting events or awards.
- [Introduction](https://trophy-mintlify-b0666975.mintlify.app/api-reference/introduction.md): Get started with the Trophy Application API to build achievements, streaks, points, and leaderboards into your web or mobile application.
- [Rate Limiting](https://trophy-mintlify-b0666975.mintlify.app/api-reference/rate-limiting.md): Learn the Trophy Application API rate limit tiers, per-endpoint quotas, and how to handle 429 responses gracefully in your integration.
- [Achievements](https://trophy-mintlify-b0666975.mintlify.app/features/achievements.md): Reward users with metric, API, streak, and composite achievements to encourage progress and drive discovery across your product experience.
- [Emails](https://trophy-mintlify-b0666975.mintlify.app/features/emails.md): Send automated, branded gamification emails like progress updates and reactivation messages to keep users engaged outside your app.
- [Events](https://trophy-mintlify-b0666975.mintlify.app/features/events.md): Send events to Trophy to represent user interactions against metrics and trigger achievements, streaks, points, and leaderboard updates.
- [Leaderboards](https://trophy-mintlify-b0666975.mintlify.app/features/leaderboards.md): Create daily, weekly, or monthly recurring leaderboards that rank users by metrics, points, or streaks to drive competition and engagement.
- [Metrics](https://trophy-mintlify-b0666975.mintlify.app/features/metrics.md): Model any user interaction with Trophy metrics to power achievements, streaks, points, and leaderboards from a single source of truth.
- [Overview](https://trophy-mintlify-b0666975.mintlify.app/features/overview.md): Understand the core Trophy concepts including metrics, events, users, achievements, streaks, points, and leaderboards that power gamification.
- [Points](https://trophy-mintlify-b0666975.mintlify.app/features/points.md): Build XP and points systems with triggers, levels, and boosts to reward users for in-app actions and create long-term progression loops.
- [Push Notifications](https://trophy-mintlify-b0666975.mintlify.app/features/push-notifications.md): Send automated, branded push notifications for achievements, streaks, and progress updates to bring users back into your mobile app.
- [Streaks](https://trophy-mintlify-b0666975.mintlify.app/features/streaks.md): Build daily, weekly, or monthly streaks with streak freezes and rankings to create habits and keep users returning to your app daily.
- [Users](https://trophy-mintlify-b0666975.mintlify.app/features/users.md): Identify and track users in Trophy to attribute events, achievements, streaks, and points across your entire product userbase over time.
- [Welcome to Trophy](https://trophy-mintlify-b0666975.mintlify.app/getting-started/introduction.md): Trophy is a developer toolkit for adding achievements, streaks, points, leaderboards, and gamified emails to any web or mobile app.
- [Quick Start](https://trophy-mintlify-b0666975.mintlify.app/getting-started/quickstart.md): Integrate Trophy into your backend in under 10 minutes to start tracking events, awarding achievements, and powering gamified user experiences.
- [How to Build a Gamified Fitness Tracker](https://trophy-mintlify-b0666975.mintlify.app/guides/gamified-fitness-platform.md): Build a Strava-style fitness app with Next.js and Trophy, featuring multi-sport tracking, city leaderboards, streaks, and XP progression.
- [Environments](https://trophy-mintlify-b0666975.mintlify.app/platform/environments.md): Isolate development, staging, and production data with Trophy environments and safely promote gamification changes before going live.
- [Experimentation](https://trophy-mintlify-b0666975.mintlify.app/platform/experimentation.md): Run A/B tests on your Trophy gamification experience with control flags to measure retention and engagement lifts before rolling out.
- [Multi-Tenancy](https://trophy-mintlify-b0666975.mintlify.app/platform/multi-tenancy.md): Use Trophy multi-tenancy to provision and customize separate gamification configurations for each of your B2B customers from one account.
- [Overview](https://trophy-mintlify-b0666975.mintlify.app/platform/overview.md): Configure and operate the Trophy platform using environments, multi-tenancy, and experimentation to manage gamification across customers at scale.
- [Gamification UI Kit](https://trophy-mintlify-b0666975.mintlify.app/uikit/overview.md): Trophy's Gamification UI Kit is a React component library built on shadcn/ui for streaks, achievements, leaderboards, points, and levels.
- [Achievement completed](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/achievements/achievement-completed.md): Triggered when a user completes an achievement.
- [Leaderboard changed](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/leaderboards/leaderboard-changed.md): Triggered when leaderboard rankings change.
- [Leaderboard finished](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/leaderboards/leaderboard-finished.md): Triggered when a run of a leaderboard finishes.
- [Leaderboard rank changed](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/leaderboards/leaderboard-rank-changed.md): Triggered when a user's leaderboard rank changes.
- [Leaderboard started](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/leaderboards/leaderboard-started.md): Triggered when a run of a leaderboard begins.
- [Points boost finished](https://trophy-mintlify-b0666975.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-b0666975.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-b0666975.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-b0666975.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-b0666975.mintlify.app/webhooks/events/streaks/streak-extended.md): Triggered when a user extends an existing active streak.
- [Streak freeze consumed](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/streaks/streak-freeze-consumed.md): Triggered when a user consumes a streak freeze.
- [Streak freeze earned](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/streaks/streak-freeze-earned.md): Triggered when a user earns streak freezes.
- [Streak lost](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/streaks/streak-lost.md): Triggered when a user loses their streak.
- [Streak started](https://trophy-mintlify-b0666975.mintlify.app/webhooks/events/streaks/streak-started.md): Triggered when a user starts a streak.
- [Idempotency](https://trophy-mintlify-b0666975.mintlify.app/webhooks/idempotency.md): Make your Trophy webhook handlers idempotent using event IDs so you safely process each event exactly once even when retries occur.
- [Introduction](https://trophy-mintlify-b0666975.mintlify.app/webhooks/introduction.md): Receive Trophy webhook events for achievements, streaks, points, and leaderboards to power custom integrations and real-time workflows.
- [Observability](https://trophy-mintlify-b0666975.mintlify.app/webhooks/observability.md): Monitor and diagnose Trophy webhook delivery using built-in dashboard analytics, status tracking, payload inspection, and delivery logs.
- [Quick Start](https://trophy-mintlify-b0666975.mintlify.app/webhooks/quickstart.md): Configure a Trophy webhook endpoint in under 10 minutes and start receiving real-time gamification events directly in your backend service.
- [Retries](https://trophy-mintlify-b0666975.mintlify.app/webhooks/retries.md): Understand how Trophy retries failed webhook deliveries after timeouts or non-2xx responses, with backoff schedules and dead-letter handling.
- [Security](https://trophy-mintlify-b0666975.mintlify.app/webhooks/security.md): Secure your Trophy webhook endpoints by verifying signed payloads with HMAC signatures to ensure events come from Trophy and not attackers.

## OpenAPI Specs

- [application](https://trophy-mintlify-b0666975.mintlify.app/openapi/application.yml)
- [admin](https://trophy-mintlify-b0666975.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)