# BitLabs Client API ## Description This is version `2.0.126` of this API documentation. Last update on Dec 22, 2025. BitLabs' public API to be integrated by our own products as well as publishers who desire maximum customization. ## Servers - https://api.bitlabs.ai: https://api.bitlabs.ai () ## Authentication The API accepts 5 different authentication methods: - Header s2s token (http_api_key) - Query api token (http_api_key) & Query user (http_api_key) - Header api token (http_api_key) & Header user (http_api_key) - Header bearer token (http) - Header api token (http_api_key) ## Endpoints and operations ### [Surveys](https://docs.bitlabs.ai/group/endpoint-surveys.md) - [Get Surveys](https://docs.bitlabs.ai/operation/operation-getsurveysv2.md) - [Open click](https://docs.bitlabs.ai/operation/operation-createandredirectclickv2.md) - [Create click](https://docs.bitlabs.ai/operation/operation-createclickv2.md) - [Get click](https://docs.bitlabs.ai/operation/operation-getclickv2.md) - [Update click](https://docs.bitlabs.ai/operation/operation-updateclickv2.md) - [Get survey reconciliation count](https://docs.bitlabs.ai/operation/operation-getsurveyreconciliationcount.md) ### [Offers](https://docs.bitlabs.ai/group/endpoint-offers.md) - [Get Offers](https://docs.bitlabs.ai/operation/operation-getoffersv2.md) - [Store Mobile Advertising ID](https://docs.bitlabs.ai/operation/operation-storemobileadvertisingid.md) - [Get user history offer details](https://docs.bitlabs.ai/operation/operation-getuserhistoryofferdetails.md) ### [Magic-Receipts](https://docs.bitlabs.ai/group/endpoint-magic-receipts.md) - [Get access token for magic receipts](https://docs.bitlabs.ai/operation/operation-getmagicreceiptaccesstoken.md) - [Get user history magic receipt offer details](https://docs.bitlabs.ai/operation/operation-getuserhistorymagicreceiptofferdetails.md) ### [User](https://docs.bitlabs.ai/group/endpoint-user.md) - [Get user history](https://docs.bitlabs.ai/operation/operation-getuserhistory.md) - [Get user](https://docs.bitlabs.ai/operation/operation-getuser.md) - [Update user](https://docs.bitlabs.ai/operation/operation-updateuser.md) - [Get level info](https://docs.bitlabs.ai/operation/operation-getlevelinfo.md) - [Claim the reward](https://docs.bitlabs.ai/operation/operation-claimxpreward.md) - [Spin the wheel](https://docs.bitlabs.ai/operation/operation-spinwheel.md) - [Get the progress of a goal](https://docs.bitlabs.ai/operation/operation-getpromotionprogress.md) - [Get the current promotion streak](https://docs.bitlabs.ai/operation/operation-getcurrentstreak.md) - [Spin the wheel for the welcome bonus reward if available](https://docs.bitlabs.ai/operation/operation-spinwheelwelcomebonus.md) - [Get user's welcome bonus, if eligible](https://docs.bitlabs.ai/operation/operation-getwelcomebonus.md) - [Claim user's welcome bonus](https://docs.bitlabs.ai/operation/operation-claimwelcomebonus.md) - [Attempt to generate a referral code for the user](https://docs.bitlabs.ai/operation/operation-generatereferralcode.md) - [Get user's referral bonus info](https://docs.bitlabs.ai/operation/operation-getreferralbonus.md) - [Attempt to activate a referral code](https://docs.bitlabs.ai/operation/operation-activatereferralcode.md) - [Get user's referral info](https://docs.bitlabs.ai/operation/operation-getreferralinfo.md) - [Claim user's reward](https://docs.bitlabs.ai/operation/operation-claimrewardbyrewardtype.md) ### [Server-Side](https://docs.bitlabs.ai/group/endpoint-server-side.md) - [Import Users](https://docs.bitlabs.ai/operation/operation-importusers.md) - [Delete user](https://docs.bitlabs.ai/operation/operation-deleteuser.md) - [Get user data for publishers](https://docs.bitlabs.ai/operation/operation-getpublisheruserprofile.md) - [Get user GDPR requests](https://docs.bitlabs.ai/operation/operation-getusergdprrequests.md) - [Create GDPR data request](https://docs.bitlabs.ai/operation/operation-accessuser.md) - [Get Offers for Publishers](https://docs.bitlabs.ai/operation/operation-getpublisheroffersv2.md) - [Fetch offer revenue report](https://docs.bitlabs.ai/operation/operation-getpublisherreport.md) - [Create auth token for user](https://docs.bitlabs.ai/operation/operation-creates2sauthentication.md) - [Test a callback URL](https://docs.bitlabs.ai/operation/operation-testcallbackurl.md) - [Test a callback URL](https://docs.bitlabs.ai/operation/operation-performtestcallback.md) - [Get revenue for an app](https://docs.bitlabs.ai/operation/operation-getapprevenue.md) ### [Cashback](https://docs.bitlabs.ai/group/endpoint-cashback.md) - [Get user history cashback details](https://docs.bitlabs.ai/operation/operation-getuserhistorycashbackdetails.md) ### [Internal](https://docs.bitlabs.ai/group/endpoint-internal.md) - [Validate zipcode](https://docs.bitlabs.ai/operation/operation-validatezipcode.md) - [Update user legal information](https://docs.bitlabs.ai/operation/operation-setuserlegal.md) - [Update user marketing information](https://docs.bitlabs.ai/operation/operation-setusermarketing.md) - [Get app settings](https://docs.bitlabs.ai/operation/operation-getappsettings.md) - [Get app settings v2](https://docs.bitlabs.ai/operation/operation-getappsettingsv2.md) - [Get app leaderboard](https://docs.bitlabs.ai/operation/operation-getleaderboard.md) - [Download GDPR file](https://docs.bitlabs.ai/operation/operation-getgdprfilev2.md) - [Get user balance](https://docs.bitlabs.ai/operation/operation-getuserbalance.md) - [Set custom fields](https://docs.bitlabs.ai/operation/operation-setcustomfields.md) - [Get url for magic receipts](https://docs.bitlabs.ai/operation/operation-getmagicreceipturl.md) - [Get user GDPR requests](https://docs.bitlabs.ai/operation/operation-getgdpruserrequests.md) - [Create GDPR data request](https://docs.bitlabs.ai/operation/operation-accessgdpruser.md) - [Delete GPDR data request](https://docs.bitlabs.ai/operation/operation-deletegdpruser.md) - [Get user preferred email channels](https://docs.bitlabs.ai/operation/operation-getusernotificationchannels.md) - [Set user preferred notifications](https://docs.bitlabs.ai/operation/operation-setusernotificationchannels.md) - [Unsubscribe user from notifications](https://docs.bitlabs.ai/operation/operation-unsubscribeusernotifications.md) - [Create user payout request](https://docs.bitlabs.ai/operation/operation-createuserpayoutrequest.md) - [Get user payout history](https://docs.bitlabs.ai/operation/operation-getuserpayouthistoryv2.md) - [Create user payout request](https://docs.bitlabs.ai/operation/operation-createuserpayoutrequestv2.md) - [Get user payout history](https://docs.bitlabs.ai/operation/operation-getuserpayouthistory.md) - [Get card inventory brands](https://docs.bitlabs.ai/operation/operation-getcardinventorybrands.md) - [Get cashback offers](https://docs.bitlabs.ai/operation/operation-getcashbackoffers.md) [Powered by Bump.sh](https://bump.sh)