Contents
On this page

List Collections - Plugixa Recipe

GET /plugixa-recipe/v1/collections

List collections, cookbooks and meal plans, with the number of recipes in each.

Needs a signed-in user who can open Plugixa Recipe: the plugixa_recipe_manage capability, or WordPress’s edit_posts (Contributor and up). Needs Plugixa Recipe Pro with the Collections app on.

Note. Responses say active and inactive, but the status filter compares the stored values: filter with published for active collections and draft for inactive ones.

Request

GET https://your-site.example/wp-json/plugixa-recipe/v1/collections?filter[type]=meal_plan

Query parameters

Name Type Default Description
search string Matches the name or the description.
status string published (active) or draft (inactive).
filter[type] string collection, cookbook, meal_plan or favorites.
filter[visibility] string public or private.
filter[user_id] integer Collections created by this user.

Plus the list parameters every list accepts. orderby accepts name, created_at (the default), modified_at, display_order and type.

Responses

200 OK. data.items is one page of collections.

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": "4",
        "name": "Weekday Dinners",
        "slug": "weekday-dinners",
        "description": "Quick dinners for busy evenings.",
        "image_id": null,
        "type": "collection",
        "status": "active",
        "is_featured": false,
        "display_order": "0",
        "user_id": "1",
        "visibility": "public",
        "created_at": "2026-11-12 09:30:00",
        "modified_at": null,
        "title": "Weekday Dinners",
        "is_public": true,
        "recipe_count": 1,
        "author_name": "Site Admin"
      }
    ],
    "total": 1,
    "limit": 20,
    "offset": 0
  }
}
Field Type Meaning
data.items[] object A collection, as in Get Collection, without recipes
data.items[].recipe_count integer Recipes linked, in any status
data.items[].author_name string The creator’s display name
data.total integer Collections matching the filters

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-recipe/v1/collections?search=dinner" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'search' => 'dinner',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-recipe/v1/collections?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const auth = 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`);
const query = new URLSearchParams({ search: 'dinner' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-recipe/v1/collections?${query}`, {
  headers: {
    'Authorization': auth,
  },
});
const { data } = await response.json();

Quick Links

Share