Get started
Nipto API
Read and log the chores of your tribe from Home Assistant, iOS Shortcuts or your own scripts with the Nipto GraphQL API.
Nipto turns household chores into a weekly game for the whole tribe. The Nipto API lets your smart home, dashboards and scripts read that game and play it: who did what this week, the eggs and levels of each member, the Planning, the gems and the shop, and logging a task the moment it is done.
Endpoint
It is a GraphQL API with a single endpoint. Send a POST with a JSON body holding a query (and optional variables):
POST https://nipto.app/graphql
Content-Type: application/json
Authorization: YOUR_TOKENA raw GraphQL body with Content-Type: application/graphql works too, and so do GET requests with a query parameter. Several operations can be sent at once as a JSON array. Opening the endpoint in a browser shows an explorer where you can try queries.
Your first call
Get your token in the app (see Authentication), then list the members of your tribe:
curl https://nipto.app/graphql \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_TOKEN' \
-d '{"query":"{ users { uid name objective } }"}'{
"data": {
"users": [
{ "uid": "IjKLw2GSVWbmWYFYOyApPgEw6X82", "name": "Camille", "objective": null },
{ "uid": "q6Rz7RHjW7YJtwv9xVZI69LKC4s1", "name": "Léo", "objective": 90 }
]
}
}What you can do
| To | Use |
|---|---|
| List the members of the tribe | users |
| List the tasks and what each one is worth in eggs | tasks |
| See what was done this week | activities |
| Read past weeks: eggs, levels, streaks | weeks |
| Read the Planning | reminders |
| Read the gems and the shop | wallets, rewards, purchases |
| Log a task as done | createActivity |
| Remove an activity of this week | deleteActivity |
| Plan a task, once or repeating | createReminder |
Before you start
- The API is for Premium tribes. See Premium.
- Each token allows 2,000 calls a day. See Rate limits.
- Dates come back in UTC. A date alone sent as an argument, like
"2026-03-15", means that day where your tribe lives, and times of day and weeks follow the time zone of your tribe too. See Time zones. - The app talks about eggs, levels and the tribe, the API about points, results and the team. See Vocabulary.
- Ready-made setups: Home Assistant and iOS Shortcuts.
Stability
Automations built on the API keep working: fields are added, never removed or renamed. A field that should no longer be used is marked deprecated in the reference and keeps answering. Questions or problems: write to support@nipto.app.