Contents
On this page

Plugixa Recipe REST API - Plugixa Recipe

The integration surface for Plugixa Recipe: recipes with their ingredients, instructions and nutrition, the categories, cuisines and courses they sit in, and reviews you can moderate, plus the public routes a headless front end needs to show published recipes, take reviews, and keep a visitor’s favorites. With Plugixa Recipe Pro, collections, meal plans and shopping lists too. Enough to sync recipes from another system, feed an app, or build your own front end.

Everything lives under the namespace plugixa-recipe/v1. The admin app itself uses these routes, and every permission it shows is enforced at the endpoint rather than in the page.

Base URL

https://your-site.example/wp-json/plugixa-recipe/v1

On a site with plain permalinks, pass the route as a parameter instead:

https://your-site.example/?rest_route=/plugixa-recipe/v1/recipes

Authentication

Plugixa Recipe has no API keys of its own. It uses WordPress’s sign-in, so a request acts as a WordPress user.

Caller How it signs in
A script or another system An Application Password, created under Users -> Profile -> Application Passwords, sent with HTTP Basic auth
The admin app, or your own JavaScript on the site The logged-in cookie plus an X-WP-Nonce header, the normal WordPress way
A visitor on a headless front end Nothing, on the public /frontend read routes; their own sign-in for favorites, likes and their shopping list
curl -s "https://your-site.example/wp-json/plugixa-recipe/v1/recipes" \
  -u "admin:$WP_APP_PASSWORD"

WordPress offers Application Passwords on sites served over HTTPS. Use a user with the least access the job needs: an Application Password can do everything its user can.

Permissions

Every admin route asks one question: may this user perform this action? The answer is the plugin’s own capability, or the WordPress capability that has always granted the same access.

Action Plugin capability Or WordPress capability Held by default by
Read (lists and single reads) plugixa_recipe_manage edit_posts Contributor and up
Create and edit plugixa_recipe_edit edit_posts Contributor and up
Delete plugixa_recipe_delete delete_published_posts Author and up
Publish a recipe, or moderate a review plugixa_recipe_publish publish_posts Author and up

Publishing is checked on top of editing: a save that moves a recipe into or out of published, or changes a review’s status, needs both. A Contributor can still write drafts and submit them as pending.

With Plugixa Recipe Pro, the Permissions app can narrow this further, for example to a person’s own recipes, and their lists then only show their own rows. See Roles and permissions.

Apps

Recipes, categories, cuisines and courses are always on. Reviews, Favorites, Nutrition and Visitor Account are apps you can switch off under Plugixa Recipe -> App Manager, as are the Pro apps Collections and Shopping Lists. An app that is off takes its routes with it: they answer 404.

Responses

Every successful response is wrapped the same way, and its HTTP status is 200, creates and deletes included:

{
  "success": true,
  "message": "Recipe deleted.",
  "data": null
}

message is a human-readable note, often empty. data is the record, the list, or null.

Most values come back as the database stores them: ids, counts, flags and times are numeric strings ("id": "12", "is_featured": "0"). Each endpoint page says which fields the plugin turns into real numbers or booleans. Datetimes are in the site’s own timezone, in the form 2026-11-12 09:30:00.

Lists and pagination

Admin lists return data as an object with the rows in items and the totals beside them. Nothing is sent in headers (X-WP-Total is not used).

{
  "success": true,
  "message": "",
  "data": {
    "items": [],
    "total": 37,
    "limit": 20,
    "offset": 0
  }
}
Parameter Type Default Description
limit integer 20 Rows to return. 0 or -1 returns every row
per_page integer Same as limit, and wins over it when both are sent
offset integer 0 Rows to skip. Use this to page
orderby string created_at One of the sortable columns each endpoint lists. Anything else falls back to that endpoint’s default. sort_by is accepted too
order string DESC ASC or DESC, in capitals
sort_order string Same as order, in any case, and wins over it
search string Substring search over the columns each endpoint lists
filter[...] object Further filters each endpoint lists, as filter[difficulty]=easy

Note. page has no effect on these lists: offset always defaults to 0 and is used instead. Page with offset = (page - 1) * limit.

Note. order=desc in lower case is refused with 400 rest_invalid_param. Send DESC, or use sort_order, which accepts either case.

Count pages yourself from total and limit.

Endpoints

Resource Endpoints
Recipes List, Create, Get, Update, Delete, Update status, Duplicate
Ingredients List, Replace
Instructions List, Replace
Nutrition Get, Update, Delete
Categories List, Create, Get, Update, Delete
Cuisines List, Create, Get, Update, Delete
Courses List, Create, Get, Update, Delete
Reviews List, Get, Update, Moderate, Delete
Public recipes List, Get
Public reviews List, Submit, Vote helpful
Favorites Toggle, Saved recipes
Likes Toggle
Collections PRO List, Create, Get, Update, Delete, Recipes, Add recipe, Remove recipe, Public list
Shopping lists PRO List, Create, Get, Update, Delete, Add item, Update item, Delete item, From recipe, From meal plan, My list, Replace my list

Errors

Errors use the standard WordPress shape. The plugin’s own refusals all carry the code rest_error, with a per-field map in data.errors when a field is to blame:

{
  "code": "rest_error",
  "message": "Title is required.",
  "data": {
    "status": 400,
    "errors": { "title": "Title is required." }
  }
}

These can come back from any endpoint. Each endpoint page lists its own errors on top of them.

Status Code When
403 rest_forbidden An admin route was called without a permission it needs, including when the request is not signed in at all.
401 rest_forbidden A route that needs a signed-in user (favorites, likes, saved recipes, the visitor’s shopping list) was called signed out.
401 incorrect_password, invalid_username WordPress refused the Application Password.
403 rest_cookie_invalid_nonce A cookie request carried a missing or stale nonce.
404 rest_no_route No such route or method, or the app that registers it is switched off.
400 rest_invalid_param A parameter failed validation, for example order in lower case.
500 rest_error The database refused a write.

Rate limits

Admin routes and public reads are not rate-limited. Two public writes are, per IP address and per hour: posting a review (at most 10) and voting a review helpful (at most 60). The Posts per hour, per visitor setting under Captcha can lower both. Going over answers 429.

Filtering what comes back

Several hooks change what the API returns or accepts, in PHP, without touching the routes:

Hook Type Changes
plugixa_recipe_prepare_recipe_admin Filter A recipe as the admin routes return it (Get Recipe, and the reads after a create, update or duplicate)
plugixa_recipe_prepare_recipe_frontend Filter A recipe from Get Published Recipe
plugixa_recipe_validate_recipe Filter Return a WP_Error to refuse a recipe create or update before anything is written
plugixa_recipe_user_can Filter The answer to every permission check, with the action, the entity and the record
plugixa_recipe_owner_scope Filter Limits an admin list to one user’s rows
plugixa_recipe_save_recipe Action Fires after a recipe is created or updated, with the request body
plugixa_recipe_delete_recipe Action Fires before a recipe row is deleted
plugixa_recipe_rest_controllers Filter Adds your own controller classes to the namespace

See Hooks for the full set.

Troubleshooting

Symptom Usual cause
403 rest_forbidden from a script The request arrived signed out (no Application Password sent, the host strips the Authorization header, or the site is not on HTTPS), or its user lacks the capability.
401 incorrect_password The Application Password is wrong or was revoked.
403 rest_cookie_invalid_nonce from the browser The nonce is missing or stale. Reload the page.
404 on a route that should exist Its app is off in the App Manager, or it is a Pro route on the free build.
Every page of a list is the same You are sending page. Send offset instead.
400 rest_invalid_param on a list order is in lower case. Send ASC or DESC.
A Contributor’s save is refused with 403 The save publishes the recipe or takes it down. Keep the status, or use an Author.
A new recipe is refused with 400 although it is a draft Create checks every required field whatever the status.

See also

Quick Links

Share