---
title: "returns list of users"
method: GET
path: "/kkid/userlist"
tags: ["KKid"]
---

# returns list of users

`GET /kkid/userlist`

By passing in the appropriate options, you can search for
users within the authenticated user's master account

## Query parameters

- `isChild` boolean
- `isActive` boolean
- `isAdmin` boolean
- `enableAllowance` boolean
- `enableChores` boolean
- `userID` integer
- `username` string
- `email` string

## Response `200`

search results matching criteria

- Userlist — userlist
  - `success` boolean
  - `user` User[]
    - `userId` integer
    - `masterId` integer
    - `homeId` integer
    - `username` string
    - `firstName` string
    - `lastName` string
    - `email` string
    - `isActive` boolean
    - `isAdmin` boolean
    - `enableAllowance` boolean
    - `isBanned` boolean
    - `isChild` boolean
    - `enableChores` boolean
    - `isDisabled` boolean
    - `isLocked` boolean
    - `isMaster` boolean
    - `enableBehaviorChart` boolean
    - `enableNoAds` boolean
    - `enableTmdb` boolean
    - `enableObjectDetection` boolean
    - `weeklyAllowance` integer
    - `emoji` string
    - `tmdbKey` string
    - `pushChores` boolean
    - `pushChoresNew` boolean
    - `pushChoresReminders` boolean
    - `pushAllowance` boolean
    - `pushAllowanceNew` boolean

## Other responses

- `202` — Accepted- Access Granted but data flow did not complete due to an unknown error.
- `204` — No Data Returned
- `400` — bad input parameter
- `401` — Unauthorized- API credentials not supplied. Ensure you have passed proper Username and Password parameters
- `403` — Forbidden- User access is denied. API user either does not have access or has been banned/locked.
- `405` — Method Not Allowed- API user does not have access to use this method
- `412` — API Access Denied! Your API key is invalid, expired, or not supplied!

---

[API](https://skmtc.net/kumpeapps/apis/kumpeapps-api.md) · [All operations](https://skmtc.net/kumpeapps/apis/kumpeapps-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kumpeapps/kumpeapps-api/versions/0f0bb0e58cc2/schema)