# Mufi

## Docs

- [Introduction](https://docs.mufi.app/docs/introduction.md): The developer platform for fan engagement, creator monetization, and digital experiences
- [Quickstart](https://docs.mufi.app/docs/quickstart.md): Go from zero to your first API call in 5 minutes
- [Best Practices](https://docs.mufi.app/docs/best-practices.md): Security guidelines for building with the Mufi API
- [Wallets API](https://docs.mufi.app/docs/wallet-api/introduction.md): Custodial and non-custodial wallet management for the Polkadot network
- [Events](https://docs.mufi.app/docs/events-overview.md): Create, manage, and track events with attendee registration and check-ins
- [Products](https://docs.mufi.app/docs/products-overview.md): Issue digital products — tickets, vouchers, perks, and NFT collectibles
- [Authentication](https://docs.mufi.app/docs/wallet-api/authentication.md): How to authenticate your API requests and manage API keys
- [Security](https://docs.mufi.app/docs/wallet-api/security.md): Learn how Mufi keeps your assets secure
- [Custodians](https://docs.mufi.app/docs/wallet-api/custodians.md): Learn how Mufi manages your wallet secrets
- [Bring Your Own Wallet](https://docs.mufi.app/docs/wallet-api/noncustodial.md): Learn how to attach your non custodial wallet
- [API Version](https://docs.mufi.app/docs/endpoint/version/api-version.md): Retrieve the current version of the API. This endpoint serves as a health check to ensure the API is operational and can be used to verify the availability of new API endpoints based on the version number. It returns a JSON object containing the version string, which can be useful for debugging and…
- [Introduction](https://docs.mufi.app/docs/users/introduction.md): Create and manage users with custodial wallets on the Polkadot network
- [Create User](https://docs.mufi.app/docs/endpoint/wallets/create-user.md): Users are created immediately and will have a blockchain wallet asynchronously created in the background.
- [Fetch User](https://docs.mufi.app/docs/endpoint/wallets/fetch-user.md): Retrieve detailed information about a user, including their associated wallets, by querying with `email`, `id`, or `referenceId`.
- [Fetch Users](https://docs.mufi.app/docs/endpoint/wallets/fetch-users.md): Retrieve users linked to your project application. This `POST` endpoint allows querying by `email`, `id`, or `referenceId`. Use only one field; priority is given to `email`, then `referenceId`, and finally `id` in the MuFi database.
- [Activate User](https://docs.mufi.app/docs/endpoint/wallets/activate-user.md): Set a user to activated. Activation status is required to manage any features associated with their wallets. The current date is used as the activation date. You can query the activation status of a user using the `POST /v1/users/activation` endpoint.
- [User Activation Status](https://docs.mufi.app/docs/endpoint/wallets/user-activation-status.md): Get the activation status of a user. Users are activated after calling the `POST /v1/users/activate` endpoint.
- [Get Wallet Balances](https://docs.mufi.app/docs/endpoint/wallets/get-wallet-balances.md): Get the balances of a user's wallets for a given blockchain.
- [Get User Count](https://docs.mufi.app/docs/endpoint/wallets/get-user-count.md): Get the number of active users.
- [Fetch Wallets](https://docs.mufi.app/docs/endpoint/wallets/fetch-wallets.md): Get all wallets for a project.
- [Introduction](https://docs.mufi.app/docs/events/introduction.md): Create and manage events with attendee registration and check-in
- [Event Creation](https://docs.mufi.app/docs/endpoint/engagement/event-creation.md): Create a new event record for a project. This can be used to track events such as music festivals, conferences, or any other event that can be attended by users.
- [Event Deletion](https://docs.mufi.app/docs/endpoint/engagement/event-deletion.md): Delete an existing event record for a project. This will remove the event from the project and all associated data.
- [Get Event](https://docs.mufi.app/docs/endpoint/engagement/get-event.md): Fetch an existing event record for a project.
- [Fetch Events](https://docs.mufi.app/docs/endpoint/engagement/fetch-events.md): Fetch all events for a project ordered by creation date and then ID. Results can be paginated with `page` and `limit` query parameters.
- [Fetch Event Attendees](https://docs.mufi.app/docs/endpoint/engagement/fetch-event-attendees.md): Fetch the attendees of an event. This is used to get a list of users that have registered to attend the event.
- [Event Attendee Registration](https://docs.mufi.app/docs/endpoint/engagement/event-attendee-registration.md): Register a user to an event. This is used to create a record of the user attending the event and can by used to update the timestamp of the registration or attendance.
- [Event Update](https://docs.mufi.app/docs/endpoint/engagement/event-update.md): Update an existing event record for a project. This can be used to update the event name, description, start date, and end date.
- [Introduction](https://docs.mufi.app/docs/products/introduction.md): Create products, issue items, and manage redemptions and transfers
- [Create Product](https://docs.mufi.app/docs/endpoint/engagement/create-product.md): Create a new product for an event. Products define redeemable items that can be distributed to users, such as vouchers, coupons, or digital collectibles.
- [List Products](https://docs.mufi.app/docs/endpoint/engagement/list-products.md): Fetch all products for a project ordered by creation date. Results can be paginated with `page` and `limit` query parameters.
- [Get Product](https://docs.mufi.app/docs/endpoint/engagement/get-product.md): Fetch a single product by ID for the project.
- [Create Product Items](https://docs.mufi.app/docs/endpoint/engagement/create-product-items.md): Issue product items to users by user ID or email. Users must be customers of the project. At least one of `users` or `emails` must be provided.
- [Redeem Product Item](https://docs.mufi.app/docs/endpoint/engagement/redeem-product-item.md): Redeem a product item on behalf of a user. Product items can only be redeemed once.
- [List Product Sales](https://docs.mufi.app/docs/endpoint/engagement/list-product-sales.md): Fetch all sales (order items) for a product. Results are paginated.
- [Transfer Product Item](https://docs.mufi.app/docs/endpoint/engagement/transfer-product-item.md): Transfer a product item from one user to another. The product must have `is_transferable` set to true. Users can be identified by email or user ID.

## OpenAPI Specs

- [openapi](https://docs.mufi.app/openapi.yaml)
- [package](https://docs.mufi.app/package.json)
- [package-lock](https://docs.mufi.app/package-lock.json)