# Docs.flyy Documentation

> Documentation for Docs.flyy

## Guides
- [Introduction](https://docs.theflyy.com/docs/introduction-2.md)
- [Android](https://docs.theflyy.com/docs/flyy-sdk-documentation-for-android.md): Resources for using Flyy's Android SDK
- [Setup Guide](https://docs.theflyy.com/docs/setup-guide.md): Setting up the Flyy SDK in your Android app
- [Create your First Campaign](https://docs.theflyy.com/docs/create-and-track-your-first-offer.md): Create and Implement your First Campaign in your Android App
- [SDK Documentation](https://docs.theflyy.com/docs/sdk-documentation.md): Overview of all the SDK features available
- [Campaign Guides](https://docs.theflyy.com/docs/campaign-guides.md): Campaign Guides for Android SDK
- [Widgets](https://docs.theflyy.com/docs/widgets.md)
- [iOS](https://docs.theflyy.com/docs/flyy-sdk-documentation-for-ios-swift.md): Resources for using Flyy's iOS SDK
- [Setup Guide](https://docs.theflyy.com/docs/setup-guide-1.md): Setting up the Flyy SDK in your Xcode project
- [Create your First Campaign](https://docs.theflyy.com/docs/create-your-first-campaign.md): Create and implement your first campaign in your iOS
- [SDK Documentation](https://docs.theflyy.com/docs/sdk-documentation-1.md)
- [Campaign Guides](https://docs.theflyy.com/docs/campaign-guides-1.md): Campaign Implementation Guides for iOS SDK
- [Widgets](https://docs.theflyy.com/docs/widgets-1.md)
- [React Native](https://docs.theflyy.com/docs/react-native-documentation-supporting-android-and-ios.md): Resources for using Flyy's React Native Plugin
- [Setup Guide](https://docs.theflyy.com/docs/setup-guide-3.md): Setting up the Flyy SDK in your Flutter project
- [Create your First Campaign](https://docs.theflyy.com/docs/create-your-first-campaign-2.md): Create and Implement your First Campaign in your React Native Project
- [SDK Documentation](https://docs.theflyy.com/docs/sdk-documentation-3.md): Overview of all the SDK features available
- [Campaign Guides](https://docs.theflyy.com/docs/campaign-guides-3.md)
- [Widgets](https://docs.theflyy.com/docs/widgets-3.md)
- [Flutter Plugin](https://docs.theflyy.com/docs/flutter-plugin-documentation-supporting-android-and-ios.md): Resources for using Flyy's Flutter Plugin
- [Setup Guide](https://docs.theflyy.com/docs/setup-guide-2.md): Setting up the Flyy SDK in your Flutter project
- [Create your First Campaign](https://docs.theflyy.com/docs/create-your-first-campaign-1.md): Create and Implement your First Campaign in your Flutter Project
- [SDK Documentation](https://docs.theflyy.com/docs/sdk-documentation-2.md): Overview of all the SDK features available
- [Campaign Guides](https://docs.theflyy.com/docs/campaign-guides-2.md)
- [Widgets](https://docs.theflyy.com/docs/widgets-2.md)
- [Introduction](https://docs.theflyy.com/docs/introduction.md): Introduction to the Acquisition Module
- [Invite & Earn](https://docs.theflyy.com/docs/invite-earn-campaign.md): Creating and Implementing an Invite & Earn Campaign
- [Introduction](https://docs.theflyy.com/docs/introduction-1.md): Introduction to the Retention Module
- [Challenges](https://docs.theflyy.com/docs/challenges.md)
- [Flyy custom checkin view implementation](https://docs.theflyy.com/docs/flyy-custom-checkin-view-implementation.md): This document will guide you with adding flyy custom checkin view in your android layout and how to use it in your app.
- [Webhook Document](https://docs.theflyy.com/docs/webhook-document.md)

## API Reference
- [Get the list of available wallet types](https://docs.theflyy.com/reference/get_v1-partner-id-wallet-types.md): Use this endpoint retrieves all wallet_types being used in your FLYY account
- [Get credit statement for the specified wallet type](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-wallet-wallet-type-id-credits.md): Use this endpoint to retrieve credit statement of the specified wallet type
- [Get debit statement for the specified wallet type](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-wallet-wallet-type-id-debits.md): Use this endpoint to retrieve debit statement of the specified wallet type
- [Get wallet balance of a user in the specified wallet type](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-wallet-wallet-type-id.md): Use this endpoint to fetch balance of a user in the specified wallet type
- [Create a Stage User](https://docs.theflyy.com/reference/post_v1-partner-id-stage-user.md): Use this endpoint to create a user for API testing purposes. This will only work in stage APIs
- [Create a User](https://docs.theflyy.com/reference/post_v1-partner-id-user.md): Use this endpoint to create a user in the Flyy backend
- [Create a Referral Campaign Variant](https://docs.theflyy.com/reference/post_v1-partner-id-variants.md): Use this endpoint to create a referral campaign variant in the Flyy backend
- [Update the Referral Campaign Variant conditions](https://docs.theflyy.com/reference/put_v1-partner-id-variants-variant-id.md): Use this update conditions in the referral campaign variant
- [Get the Referral Campaign Variant](https://docs.theflyy.com/reference/get_v1-partner-id-variants-4.md): Get the Referral Campaign Variant
- [Get User Referral Link](https://docs.theflyy.com/reference/get_v1-partner-id-user-a3ebf518e8e747b2b0a147c09c22a9f7-referral-link.md): Use this endpoint to get a user's referral link from the Flyy backend
- [Get User Data](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id.md): Use this endpoint to fetch user details from the Flyy backend
- [Credit value to user's wallet](https://docs.theflyy.com/reference/post_v1-partner-id-user-wallet-credit.md): Use this endpoint to credit any amount to user's wallet of the specified type
- [Initiate Credit request for a user's wallet](https://docs.theflyy.com/reference/post_v1-partner-id-user-wallet-credit-initiate.md): Use this endpoint to initiate credit request into user's wallet of the specified type
- [Initiate Debit request for a user's wallet](https://docs.theflyy.com/reference/post_v1-partner-id-user-wallet-debit-initiate.md): Use this endpoint to initiate debit request into user's wallet of the specified type
- [Debit value from user's wallet](https://docs.theflyy.com/reference/post_v1-partner-id-user-wallet-debit.md): Use this endpoint to debit any amount from user's wallet of the specified type
- [Sending User Event (Deprecated)](https://docs.theflyy.com/reference/post_v2-partner-id-user-event.md): (Deprecated) this endpoint to post an event for a particular user in your FLYY account
- [Sending User Event](https://docs.theflyy.com/reference/post_v5-partner-id-user-event.md): Use this endpoint to post an event for a particular user in your FLYY account
- [User Token API](https://docs.theflyy.com/reference/post_v1-partner-id-user-ext-user-id-user-token.md): Use this request to get ext_user_token to be used for initializing the Web SDK
- [Get Segment List](https://docs.theflyy.com/reference/get_v1-partner-id-get-segments.md): This gets the list of segments in your account
- [Update Segment Title](https://docs.theflyy.com/reference/put_v1-partner-id-segments-segment-id.md)
- [Add a user to a segment](https://docs.theflyy.com/reference/post_v1-partner-id-user-ext-user-id-add-segment.md): This API adds the user with ext-user-id to the segment specified by segment_key. If the segment is not present then a new Segment is created.
- [Remove User from a Segment](https://docs.theflyy.com/reference/post_v1-partner-id-user-ext-user-id-remove-segment.md)
- [Get User Segments](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-user-segments.md): This API will give you the list of segments that the user is mapped to
- [List all Quiz](https://docs.theflyy.com/reference/get_v1-partner-id-quizzes.md)
- [Set User Properties](https://docs.theflyy.com/reference/post_v1-partner-id-user-ext-user-id-properties.md)
- [Get offers data](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-offers.md): Use this endpoint to retrieve the offers data for specific user
- [Sending Past Date User Event](https://docs.theflyy.com/reference/post_v1-partner-id-user-previous-event.md)
- [Get Referral History](https://docs.theflyy.com/reference/get_v1-partner-id-referral-history.md)
- [Verify Referrer Code](https://docs.theflyy.com/reference/get_v1-partner-id-verify-referrer-code-code.md)
- [Validate Referrer linked with a User](https://docs.theflyy.com/reference/put_v1-partner-id-user-ext-user-id-validate-referrer.md)
- [Validate User's Device Uniqueness](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-validate-device.md)
- [Update User's Referral Code](https://docs.theflyy.com/reference/put_v1-partner-id-user-ext-user-id-update-referral-code-abcd.md)
- [Delete users with GAID](https://docs.theflyy.com/reference/post_v1-partner-id-users-reset-users.md)
- [Get Specific User's Referral History](https://docs.theflyy.com/reference/get_v1-partner-id-user-ext-user-id-referral-history.md)
- [Get User IDs in a Segment](https://docs.theflyy.com/reference/get_v1-partner-id-segments-segment-key.md)
- [Get Live Quiz Tournaments](https://docs.theflyy.com/reference/get_v1-partner-quiz-tournaments.md)
- [Get Unscratched Scratchcards for last 30 days or using from_date to to_date](https://docs.theflyy.com/reference/get_v1-partner-id-get-unscratched-scratchcards.md)
- [Expiry User Scratchcards](https://docs.theflyy.com/reference/post_v1-partner-id-expiry-partner-scratchcards.md): Use this endpoint to expire scartch card using ref_num of scratch card
- [Delete User](https://docs.theflyy.com/reference/put_v1-partner-id-delete-user-ext-user-id.md): Use this to Delete User from Flyy system.
- [Update the user Transfer Request](https://docs.theflyy.com/reference/put_v1-partner-id-transfer-requests-transfer-request-id-status.md): Use this to Update Transfer Request status accept.