v1

latestOpenAPI 3.0.1Apache 2.02026-07-13332183.6 KB
KKid

returns list of chores for given user

By passing in the appropriate options, you can search for chores assigned to a given user within the authenticated user's master account

get/kkid/chorelist

Query parameters

kidUsernamestring

Username of kid you wish to search

day'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Weekly'

Day of week for chores (Weekly for weekly chores)

statusstring

Status of Chore to search

blockDashboolean

Filter results by blockDash parameter

optionalboolean

Filter results by optional parameter

canStealboolean

Filter results by canSteal parameter

includeCalendarboolean

include calendar notations (default is false)

Response

search results matching criteria

successinteger

Example response

{
  "success": 1,
  "chore": [
    {
      "reassignable": true,
      "altitude": 1,
      "notes": "notes",
      "blockDash": false,
      "kid": "jane",
      "latitude": 0,
      "choreName": "Wash Dishes",
      "choreNumber": 1,
      "extraAllowance": 5,
      "choreDescription": "Wash dishes and clean off counter",
      "stolenBy": "stolenBy",
      "day": "Monday",
      "isCalendar": false,
      "longitude": 6,
      "requireObjectDetection": "bed",
      "updatedBy": "janedoe",
      "reassigned": false,
      "optional": false,
      "oneTime": false,
      "nfcTag": "kkids//Chores?washdishestag",
      "idChoreList": 1,
      "aiIcon": "n",
      "stolen": false,
      "updated": {},
      "startDate": {},
      "status": "todo"
    },
    {
      "reassignable": true,
      "altitude": 1,
      "notes": "notes",
      "blockDash": false,
      "kid": "jane",
      "latitude": 0,
      "choreName": "Wash Dishes",
      "choreNumber": 1,
      "extraAllowance": 5,
      "choreDescription": "Wash dishes and clean off counter",
      "stolenBy": "stolenBy",
      "day": "Monday",
      "isCalendar": false,
      "longitude": 6,
      "requireObjectDetection": "bed",
      "updatedBy": "janedoe",
      "reassigned": false,
      "optional": false,
      "oneTime": false,
      "nfcTag": "kkids//Chores?washdishestag",
      "idChoreList": 1,
      "aiIcon": "n",
      "stolen": false,
      "updated": {},
      "startDate": {},
      "status": "todo"
    }
  ]
}