Grocy REST API

Name: Grocy REST API
Brand: Grocy REST API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityTask ManagementapiKey86 EndpointsREST

For Agents

Read and update household inventory, chores, tasks, and recipes on a self-hosted Grocy instance through one object-oriented REST API.

Connect the Grocy REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Grocy REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Grocy REST API.

List and create records on any Grocy entity via /objects/{entity}

Read, update, and delete a specific Grocy object by ID

Manage Grocy users and per-user permissions through /users and /users/{userId}/permissions

Read and write user fields attached to objects with /userfields/{entity}/{objectId}

GET STARTED

Start building with Grocy REST API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for Grocy REST API, keeping it validated and agent-ready. Grocy is a self-hosted ERP for the home — groceries, chores, recipes, batteries, and household tasks. The REST API exposes the underlying object store via /objects/{entity}, plus dedicated endpoints for users, user permissions, user fields, files, system metadata, and the household features the UI is built around. Authentication is a GROCY-API-KEY header issued from the Grocy admin panel.

Use Cases

Patterns agents use Grocy REST API for, with concrete tasks.

★ Voice-Driven Household Inventory

An agent records groceries as the user speaks. It calls POST /objects/{entity} with entity=products to add items and POST /objects/{entity} with entity=stock to log a purchase. Grocy's single object endpoint design means one search-and-execute pattern covers every household resource the user owns.

On each spoken item, call POST /objects/products if the product is new, then POST /objects/stock with the matching product_id and quantity to log the purchase.

Chore and Task Automation

Schedule and complete household chores automatically. The agent lists chores with GET /objects/{entity} for entity=chores, marks completion through related stock or chore-tracking objects, and logs activity with PUT /objects/{entity}/{objectId}. Useful for shared homes where chore status is tracked centrally.

List chores via GET /objects/chores, find ones due today, and update their next-execution timestamp via PUT /objects/chores/{objectId}.

Recipe and Meal Planning

Pull recipes and generate a shopping list against current stock. Recipes, meal plans, and shopping lists are all object types in Grocy reachable via /objects/{entity}. Combine recipe data with current stock to compute the missing items and write them back to a shopping list entity.

Fetch GET /objects/recipes and GET /objects/stock, compute the delta, and POST entries to /objects/shopping_list for each missing ingredient.

AI Agent Household Assistant

A home assistant agent uses Jentic to interact with the user's self-hosted Grocy instance — adding tasks, logging consumption, and reading inventory on demand. Jentic resolves Grocy's many entity-typed paths into intent-based searches, so the agent author does not need to read the Grocy schema.

Search Jentic for 'add a product to Grocy inventory', load the POST /objects/{entity} schema with entity=products, and execute with the product attributes.

Key Endpoints

86 endpoints — jentic publishes the only available openapi specification for grocy rest api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/objects/{entity}

List records of any Grocy entity

POST

/objects/{entity}

Create a record on any Grocy entity

GET

/objects/{entity}/{objectId}

Get a single Grocy object

PUT

/objects/{entity}/{objectId}

Update a Grocy object

DELETE

/objects/{entity}/{objectId}

Delete a Grocy object

GET

/system/info

Get Grocy system information

GET

/users

List Grocy users

PUT

/files/{group}/{fileName}

Upload a file to a Grocy file group

GET

/objects/{entity}

List records of any Grocy entity

POST

/objects/{entity}

Create a record on any Grocy entity

GET

/objects/{entity}/{objectId}

Get a single Grocy object

PUT

/objects/{entity}/{objectId}

Update a Grocy object

DELETE

/objects/{entity}/{objectId}

Delete a Grocy object

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The Grocy API key is stored encrypted in the Jentic MAXsystem vault. The executor injects the GROCY-API-KEY header at call time so the raw key never enters the agent's context — important when the Grocy host is on a private network.

Intent-based discovery

Agents search by intent — 'add a product to Grocy', 'list household chores' — and Jentic returns the matching /objects/{entity} call with entity prefilled, so the agent does not need to learn Grocy's entity names from the spec.

Time to first call

Direct integration: a day or two to learn the entity-based path pattern and wire userfields and file uploads. Through Jentic: minutes — search, load schema, execute.

FAQs

Specific to using Grocy REST API through Jentic.

Why is there no official OpenAPI spec for Grocy REST API?

Grocy does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Grocy REST API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Grocy API use?

Grocy accepts an API key in the GROCY-API-KEY header (or as an equivalent query parameter). Keys are managed in the Grocy admin panel. Through Jentic, the key is stored encrypted in the MAXsystem vault and the header is injected at call time.

Can I add a product to inventory through the API?

Yes — Grocy uses a single object endpoint pattern. POST /objects/{entity} with entity=products creates the product, and POST /objects/{entity} with entity=stock logs the on-hand quantity. The same pattern covers chores, tasks, and recipes.

What are the rate limits for the Grocy API?

Grocy is self-hosted, so rate limiting depends on the host's web server configuration rather than a vendor SLA. Most personal deployments have no enforced limit. Agents should still be polite and not poll aggressively.

How do I list everything in my Grocy inventory through Jentic?

Search Jentic for 'list grocy products', load the GET /objects/{entity} schema, and execute with entity=products. To read on-hand stock, repeat with entity=stock — Grocy stores quantity in a separate stock entity.

Does the Grocy API expose recipes and meal plans?

Yes — recipes, recipe ingredients, meal plans, and shopping lists are all object entities reachable via /objects/{entity}. This lets agents read the user's recipes and generate matching shopping lists.

Can I check when Grocy data last changed?

Yes. GET /system/db-changed-time returns the last database modification timestamp, useful for cache invalidation in agents that mirror Grocy data into another system.

Grocy REST API

Connect the Grocy REST API to your agent

Capabilities

Start building with Grocy REST API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs