KumpeApps API
KKid API. Due to security concerns all calls to this API requires authentication. If you have access then you may use your KumpeApps username/password to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
KKid API. Due to security concerns all calls to this API requires authentication. If you have access then you may use your KumpeApps username/password to authenticate. To gain access please use the contact developer link below.
Endpoints 33
authentication
- PUTDeactivate app key
/appkey?app_key=stringDeprecated. Pass your app key to deactivate the key - POSTRequest app key
/appkey?username=string&password=********&supportsYubikey=trueDeprecated. Request a new app key by passing username and password for app account - PATCHCompromise app key
/appkey?app_key=string&comments=stringDeprecated. Pass an app key to mark it as compromised. This may be submitted by the app owner or a concerned party that has optained the compromised app key. - PUTDeactivate app key
/authentication/appkey?app_key=stringPass your app key to deactivate the key - POSTRequest app key
/authentication/appkey?username=string&password=********&supportsYubikey=trueRequest a new app key by passing username and password for app account - PATCHCompromise app key
/authentication/appkey?app_key=string&comments=stringPass an app key to mark it as compromised. This may be submitted by the app owner or a concerned party that has optained the compromised app key. - GETRequest auth key for user (login user)
/authentication/authkey?username=string&password=********&otp=********&deviceName=string&identifierForVendor=stringObtain auth key for user that has provided their username and password to login to your app. (or to obtain an auth key for a script like IFTTT) - PUTDeactivate auth key (logout)
/authentication/authkey?auth_key=********Deactivate auth key for user logging them out of your application - POSTRequest auth key for user (login user)
/authentication/authkey?username=string&password=********&otp=********Obtain auth key for user that has provided their username and password to login to your app. (or to obtain an auth key for a script like IFTTT) - PATCHCompromise auth key
/authentication/authkey?auth_key=********&comments=stringMark user auth key as compromised - GETVerifies YubiKey OTP for authenticated user
/authentication/verifyotp?otp=stringVerifies YubiKey OTP for authenticated user - GETRequest auth key for user (login user)
/authkey?username=string&password=********&otp=********Deprecated. Obtain auth key for user that has provided their username and password to login to your app. (or to obtain an auth key for a script like IFTTT) - PUTDeactivate auth key (logout)
/authkey?auth_key=********Deprecated. Deactivate auth key for user logging them out of your application - POSTRequest auth key for user (login user)
/authkey?username=string&password=********&otp=********Deprecated. Obtain auth key for user that has provided their username and password to login to your app. (or to obtain an auth key for a script like IFTTT) - PATCHCompromise auth key
/authkey?auth_key=********&comments=stringDeprecated. Mark user auth key as compromised
KKid
- GETreturns allowance balance and allowance transactions
/kkid/allowance?kidUserId=0&transactionDays=0By passing in the appropriate options, you can view allowance balance and allowance transactions for a given user provided that they are within the masterID… - POSTadds new allowance transaction to kidUserID
/kkid/allowance?kidUserId=0&amount=0.0&description=string&transactionType=AddBy passing in the appropriate options, you can add an allowance transaction to a given user. - POSTsubscribes/unsubscribes/registers for apns push notifications
/kkid/apns?kidUserId=0&tool=register&token=string&devicename=string&title=string&message=string&badge=0&sound=string§ion=Chores&priority=passive - GETreturns list of chores for given user
/kkid/chorelist?kidUsername=string&day=Sunday&status=string&blockDash=true&optional=true&canSteal=true&includeCalendar=trueBy passing in the appropriate options, you can search for chores assigned to a given user within the authenticated user's master account - PUTupdates chore for given chore id
/kkid/chorelist?idChoreList=0&status=string&stolen=true&stolenBy=string&nfcTag=string¬es=string&latitude=0&longitude=0&altitude=0&updatedByAutomation=true&whereDay=Sunday&whereStatus=string&whereName=stringBy passing in the appropriate options, you can update the fields of a specific core within the authenticated user's master account - POSTadds chore for given user
/kkid/chorelist?kidUsername=string&day=Sunday&nfcTag=string&status=string&choreName=string&choreDescription=string&choreNumber=0&blockDash=true&oneTime=true&extraAllowance=0&optional=true&reassignable=true&canSteal=true&startDate=string¬es=string&requireObjectDetection=true&objectDetectionTag=string&updatedByAutomation=true&aiIcon=string&isCalendar=trueBy passing in the appropriate options, you can add a chore to given kid username under authenticated user's master account - DELETEdeletes chore for given chore id
/kkid/chorelist?idChoreList=0By passing in the appropriate options, you can delete a chore for the given chore id under authenticated user's master account - POSTadds new master user account
/kkid/masteruser?username=string&password=********&email=string&firstName=string&lastName=stringBy passing in the appropriate variables this method creates a new user with master account access. (The use of this method is restricted to Superusers ONLY) - GETCreate Share Link
/kkid/share?linkUserId=string&link=https://khome.kumpeapps.com/portal/wish-list.php&scope=WishList&scope2=WishList&scope3=WishList&scope4=WishListCreate share link - GETGets user info
/kkid/user?enableBool=trueGets user info for authenticated user - GETreturns list of users
/kkid/userlist?isChild=true&isActive=true&isAdmin=true&enableAllowance=true&enableChores=true&userID=0&username=string&email=stringBy passing in the appropriate options, you can search for users within the authenticated user's master account - PUTupdates user
/kkid/userlist?userID=0&username=string&email=string&firstName=string&lastName=string&emoji=string&tmdbKey=string&enableWishList=true&enableChores=true&enableAllowance=true&enableAdmin=true&enableTmdb=true&enableObjectDetection=trueBy passing in the appropriate variables this method updates the user's profile - POSTadds new child user
/kkid/userlist?username=string&password=********&email=string&firstName=string&lastName=stringBy passing in the appropriate variables this method creates a new user and assigns it to the master account of the authenticated user. By default this user… - DELETEdeletes user
/kkid/userlist?userID=0By passing in the appropriate variables this method deletes the specified user. (This function is restricted to Superusers ONLY) - GETGet list of wishlist items
/kkid/wishlist?kidUserId=0 - PUTUpdate item on kid's wishlist
/kkid/wishlist?wishId=0&title=string&description=string&priority=0&link=string - POSTAdd item to kid's wishlist
/kkid/wishlist?kidUserId=0&title=string&description=string&priority=0&link=string - DELETEDelete item from wishlist
/kkid/wishlist?wishId=0
API details
- Base URL
https://restapi.kumpeapps.com/{version}https://restapi.preprod.kumpeapps.com/{version}- Authentication
- An API key in the X-Auth header
An API key in the X-Auth header - Operations
- 33 operations on 13 pathsPOST 10GET 9PUT 7PATCH 4DELETE 3
7 marked deprecated - Main resources
- KKid 18authentication 15
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
5.0.0 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the KumpeApps API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the KumpeApps API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-Auth header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Deactivate app key” (PUT /appkey?app_key=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the KumpeApps API?
KKid API. Due to security concerns all calls to this API requires authentication. If you have access then you may use your KumpeApps username/password to… It is listed under Other and has 33 endpoints.
Who publishes the KumpeApps API?
It is listed from Kumpeapps's public API description (an OpenAPI document), not published by Kumpeapps on Swastik Codes. Anyone who controls kumpeapps.com can claim the profile by adding a DNS TXT record.
What is the base URL of the KumpeApps API?
Its description lists 2 base URLs: https://restapi.kumpeapps.com/{version}, https://restapi.preprod.kumpeapps.com/{version}. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the KumpeApps API?
It accepts 2 methods: an API key in the X-Auth header; an API key in the X-Auth header.
How many endpoints does the KumpeApps API have?
33 operations on 13 paths (10 POST, 9 GET, 7 PUT, 4 PATCH, 3 DELETE). The largest groups are KKid, authentication.
Is forking the KumpeApps API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.