v1

latestOpenAPI 3.0.1Apache 2.02026-07-13332183.6 KB
KKid

adds chore for given user

By passing in the appropriate options, you can add a chore to given kid username under authenticated user's master account

post/kkid/chorelist

Query parameters

kidUsernamestring required

username of kid to assign the chore to.

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

day of week (Monday, Tuesday....) for the chore. For weekly chores put Weekly or leave blank

nfcTagstring

text field of nfc tag required to check off chore

statusstring

status of chore (default is todo)

choreNamestring required

name of chore

choreDescriptionstring

optional chore description

choreNumberinteger

number priority of chore (default is 5)

blockDashboolean

block dash option on this chore

oneTimeboolean

mark as one time chore (does not repeat each week)

extraAllowanceinteger

ammount of allowance added at end of week for completing this chore

optionalboolean

mark as optional chore

reassignableboolean

mark as reassignable (default is true)

canStealboolean

mark as sibling can steal chore

startDatestring

date (yyyy-mm-dd) that you wish the chore to start showing up. (default is today)

notesstring

notes added to chore (visable only on reports, kids do not see this note, this is mostly just for the developer)

requireObjectDetectionboolean

require use of camera to detect object detection tag order to check off chore

objectDetectionTagstring

tag for object detection to search for (required if requireObjectDetection is true)

updatedByAutomationboolean

true if chore updated via API from an Automation System

aiIconstring

Notes if AI Icons should be used (n for no, y for yes, e for yes- error)

isCalendarboolean

True if this is a calendar note instead of a chore.

Response

search results matching criteria

successboolean
messagestring

Example response

{
  "success": true,
  "message": "success"
}