v1

latestOpenAPI 3.0.1Apache 2.02026-07-13332183.6 KB

KKid

returns list of users

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

get/kkid/userlist

Query parameters

isChildboolean

Filter Search by isChild flag

isActiveboolean

Filter Search by isActive flag

isAdminboolean

Filter Search by isAdmin flag

enableAllowanceboolean

Filter Search by enableAllowance flag

enableChoresboolean

Filter Search by enableChores flag

userIDinteger

userID of user to search

usernamestring

Username of user to search

emailstring

Email address of user to search

Response

search results matching criteria

successboolean

Example response

{
  "success": true,
  "user": [
    {
      "lastName": "Doe",
      "enableBehaviorChart": false,
      "enableTmdb": true,
      "emoji": "🤗",
      "enableObjectDetection": false,
      "pushChoresNew": true,
      "enableAllowance": true,
      "isActive": true,
      "enableNoAds": false,
      "weeklyAllowance": 5,
      "pushAllowanceNew": true,
      "pushChoresReminders": true,
      "isMaster": false,
      "isLocked": false,
      "isBanned": false,
      "isDisabled": false,
      "homeId": 1,
      "email": "jane@doe.com",
      "isChild": true,
      "enableChores": true,
      "pushAllowance": true,
      "tmdbKey": "9a87huiufe94r8",
      "pushChores": true,
      "isAdmin": false,
      "userId": 10,
      "masterId": 1,
      "firstName": "Jane",
      "username": "janedoe"
    },
    {
      "lastName": "Doe",
      "enableBehaviorChart": false,
      "enableTmdb": true,
      "emoji": "🤗",
      "enableObjectDetection": false,
      "pushChoresNew": true,
      "enableAllowance": true,
      "isActive": true,
      "enableNoAds": false,
      "weeklyAllowance": 5,
      "pushAllowanceNew": true,
      "pushChoresReminders": true,
      "isMaster": false,
      "isLocked": false,
      "isBanned": false,
      "isDisabled": false,
      "homeId": 1,
      "email": "jane@doe.com",
      "isChild": true,
      "enableChores": true,
      "pushAllowance": true,
      "tmdbKey": "9a87huiufe94r8",
      "pushChores": true,
      "isAdmin": false,
      "userId": 10,
      "masterId": 1,
      "firstName": "Jane",
      "username": "janedoe"
    }
  ]
}