# KumpeApps API API

> KumpeApps API API on Apizie: 26 endpoints (Request app key, Deactivate app key, Compromise app key, Request auth key for user (login user), …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/open-data:kumpeapps/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:kumpeapps`
- Category: Open Data
- Status: byok
- Source: https://kumpeapps.com
- Page: https://apizie.tech/api/open-data/kumpeapps
- OpenAPI: https://apizie.tech/api/open-data/kumpeapps/openapi.json

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…

## Endpoints

### Request app key
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-appkey-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | yes | Username assigned to your app |
| password | string | yes | Password assigned to your app |
| supportsYubikey | boolean | yes | App supports YubiKey OTP |

### Deactivate app key
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-appkey-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_key | string | yes | app key to deactivate |

### Compromise app key
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-appkey-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| app_key | string | yes | compromised app key |
| comments | string | no | Comments (like how was this compromised) |

### Request auth key for user (login user)
`GET https://apizie.tech/v1/open-data:kumpeapps/auth-authkey-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | yes | Authenticated username |
| password | string | yes | Authenticated password |
| otp | string | no | YubiKey OTP (if configured for user) |
| deviceName | string | no | User's device name |
| identifierForVendor | string | no | identifierForVendor for User's Device (if app is iOS) |

### Request auth key for user (login user)
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-authkey-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | yes | Authenticated username |
| password | string | yes | Authenticated password |
| otp | string | no | YubiKey OTP (if configured for user) |

### Deactivate auth key (logout)
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-authkey-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_key | string | yes | auth key to logout |

### Compromise auth key
`POST https://apizie.tech/v1/open-data:kumpeapps/auth-authkey-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| auth_key | string | yes | auth key to mark as compromised |
| comments | string | no | Comments (like how was this compromised) |

### Verifies YubiKey OTP for authenticated user
`GET https://apizie.tech/v1/open-data:kumpeapps/auth-verifyotp-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| otp | string | yes | YubiKey OTP code |

### returns allowance balance and allowance transactions
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-allowance-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUserId | integer | yes | userID of the kid |
| transactionDays | integer | no | number of days you wish to search allowance transactions (default is 90 days) |

### adds new allowance transaction to kidUserID
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-allowance-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUserId | integer | yes | userID of the kid |
| amount | number | yes | amount you wish to Add/Subtract (subtract value should be a negative value) |
| description | string | yes | Description (reason) of allowance transaction |
| transactionType | string | yes | Transaction Type (Add/Subtract) |

### subscribes/unsubscribes/registers for apns push notifications
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-apns-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUserId | integer | yes | userID of the kid |
| tool | string | yes | tool you wish to talk to |
| token | string | no | device APNS token (required for register) |
| devicename | string | no | Name of device to associate to token (required for register) |
| title | string | no | title of APNS message (required for send) |
| message | string | no | APNS message body (required for send) |
| badge | integer | no | Number for badge icon (optional for send) |
| sound | string | no | Name of sound file to play for send notification (optional for send) |
| section | string | no | Notification section name (required for send/subscribe/unsubscribe) |
| priority | string | no | Notification section name (optional for send, default is active) |

### returns list of chores for given user
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-chorelist-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUsername | string | no | Username of kid you wish to search |
| day | string | no | Day of week for chores (Weekly for weekly chores) |
| status | string | no | Status of Chore to search |
| blockDash | boolean | no | Filter results by blockDash parameter |
| optional | boolean | no | Filter results by optional parameter |
| canSteal | boolean | no | Filter results by canSteal parameter |
| includeCalendar | boolean | no | include calendar notations (default is false) |

### adds chore for given user
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-chorelist-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUsername | string | yes | username of kid to assign the chore to. |
| day | string | no | day of week (Monday, Tuesday....) for the chore. For weekly chores put Weekly or leave blank |
| nfcTag | string | no | text field of nfc tag required to check off chore |
| status | string | no | status of chore (default is todo) |
| choreName | string | yes | name of chore |
| choreDescription | string | no | optional chore description |
| choreNumber | integer | no | number priority of chore (default is 5) |
| blockDash | boolean | no | block dash option on this chore |
| oneTime | boolean | no | mark as one time chore (does not repeat each week) |
| extraAllowance | integer | no | ammount of allowance added at end of week for completing this chore |
| optional | boolean | no | mark as optional chore |
| reassignable | boolean | no | mark as reassignable (default is true) |
| canSteal | boolean | no | mark as sibling can steal chore |
| startDate | string | no | date (yyyy-mm-dd) that you wish the chore to start showing up. (default is today) |
| notes | string | no | notes added to chore (visable only on reports, kids do not see this note, this is mostly just for the developer) |
| requireObjectDetection | boolean | no | require use of camera to detect object detection tag order to check off chore |
| objectDetectionTag | string | no | tag for object detection to search for (required if requireObjectDetection is true) |
| updatedByAutomation | boolean | no | true if chore updated via API from an Automation System |
| aiIcon | string | no | Notes if AI Icons should be used (n for no, y for yes, e for yes- error) |
| isCalendar | boolean | no | True if this is a calendar note instead of a chore. |

### updates chore for given chore id
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-chorelist-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| idChoreList | integer | yes | id number of chore you wish to update |
| status | string | no | new status of chore |
| stolen | boolean | no | mark chore as stolen by sibling |
| stolenBy | string | no | username of sibling that stole the chore (required if stolen is true) |
| nfcTag | string | no | text field of NFC tag that is required to be scanned to check off this chore (normally null) |
| notes | string | no | notes field for chore |
| latitude | integer | no | GPS latitude of where the chore was marked |
| longitude | integer | no | GPS longitude of where the chore was marked |
| altitude | integer | no | GPS altitude of where the chore was marked |
| updatedByAutomation | boolean | no | true if updated via API by automation system |
| whereDay | string | no | Where day equals... |
| whereStatus | string | no | Where status equals... |
| whereName | string | no | Where chore name equals... |

### deletes chore for given chore id
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-chorelist-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| idChoreList | integer | yes | id of the chore you wish to delete |

### adds new master user account
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-masteruser-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | yes | username of user to create |
| password | string | yes | password of user to create |
| email | string | yes | email address of user to create |
| firstName | string | yes | First Name of user to create |
| lastName | string | yes | Last Name of user to create |

### Create Share Link
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-share-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| linkUserId | string | yes | User ID that the link should be authenticated to |
| link | string | yes | Link to share |
| scope | string | yes | Authentication scope for link |
| scope2 | string | no | Authentication scope for link |
| scope3 | string | no | Authentication scope for link |
| scope4 | string | no | Authentication scope for link |

### Gets user info
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-user-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| enableBool | boolean | no | Use bool values instead of Int 0/1 |

### returns list of users
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-userlist-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| isChild | boolean | no | Filter Search by isChild flag |
| isActive | boolean | no | Filter Search by isActive flag |
| isAdmin | boolean | no | Filter Search by isAdmin flag |
| enableAllowance | boolean | no | Filter Search by enableAllowance flag |
| enableChores | boolean | no | Filter Search by enableChores flag |
| userID | integer | no | userID of user to search |
| username | string | no | Username of user to search |
| email | string | no | Email address of user to search |

### adds new child user
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-userlist-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| username | string | yes | username of user to create |
| password | string | yes | password of user to create |
| email | string | yes | email address of user to create |
| firstName | string | yes | First Name of user to create |
| lastName | string | yes | Last Name of user to create |

### updates user
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-userlist-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | integer | yes | userID of the user you wish to update |
| username | string | yes | username of user to create |
| email | string | yes | email address of user to create |
| firstName | string | yes | First Name of user to create |
| lastName | string | yes | Last Name of user to create |
| emoji | string | no | emoji character for user |
| tmdbKey | string | no | User's TMdB Session Key |
| enableWishList | boolean | no | set status of Wish List module enabled |
| enableChores | boolean | no | set status of chores module enabled |
| enableAllowance | boolean | no | set status of allowance module enabled |
| enableAdmin | boolean | no | set status of isAdmin |
| enableTmdb | boolean | no | set status of enableTmdb (movie and tv search) |
| enableObjectDetection | boolean | no | set status of enableObjectDetection |

### deletes user
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-userlist-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| userID | integer | yes | userID of the user you wish to delete |

### Get list of wishlist items
`GET https://apizie.tech/v1/open-data:kumpeapps/kkid-wishlist-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUserId | integer | no | userID of the kid |

### Add item to kid's wishlist
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-wishlist-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| kidUserId | integer | yes | userID of the kid |
| title | string | yes | Item title |
| description | string | no | Item Description |
| priority | integer | no | Item Priority |
| link | string | no | URL Link to item |

### Update item on kid's wishlist
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-wishlist-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| wishId | integer | yes | Wish list item ID to update |
| title | string | no | Item title |
| description | string | no | Item Description |
| priority | integer | no | Item Priority |
| link | string | no | URL Link to item |

### Delete item from wishlist
`POST https://apizie.tech/v1/open-data:kumpeapps/kkid-wishlist-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| wishId | integer | yes | ID of wishlist item to delete |

## Example
```
curl "https://apizie.tech/v1/open-data:kumpeapps/auth-appkey-post" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the KumpeApps API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/open-data:kumpeapps/auth-appkey-post with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the KumpeApps API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. KumpeApps API itself also needs your own key from kumpeapps.com.

### Can AI agents use the KumpeApps API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:kumpeapps.

### What is the status of the KumpeApps API API?
Needs your own provider key (bring your own key)