Contents
On this page

Get Collection - Plugixa Recipe

GET /plugixa-recipe/v1/collections/{id}

Read one collection with the recipes in it.

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.

Request

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

Path parameters

Name Type Description
id integer The collection’s id

Responses

200 OK. data is the collection.

{
  "success": true,
  "message": "",
  "data": {
    "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,
    "recipes": [
      {
        "id": "12",
        "title": "Lemon Pancakes",
        "slug": "lemon-pancakes",
        "image_id": "345",
        "prep_time": "10",
        "cook_time": "15",
        "total_time": "25",
        "difficulty": "easy",
        "rating_average": 4.5,
        "status": "published",
        "display_order": "1",
        "day_number": null,
        "meal_type": null,
        "added_at": "2026-11-12 09:40:00",
        "image_url": "https://your-site.example/wp-content/uploads/2026/11/lemon-pancakes-150x150.jpg"
      }
    ],
    "recipe_count": 1
  }
}
Field Type Meaning
data.id string The collection’s id
data.name, data.title string The name, twice: title is a copy
data.type string collection, cookbook, meal_plan or favorites
data.status string active or inactive
data.visibility string public or private
data.is_public boolean visibility as a boolean
data.is_featured boolean Featured flag
data.user_id string|null The user who created it
data.recipes object[] Recipes in it, in order, with day_number and meal_type for a meal plan
data.recipe_count integer Entries in recipes
data.recipes[].status string The recipe’s own status: drafts are listed too
data.recipes[].rating_average number Average rating

Errors

Status Code When
404 rest_error No collection with that id.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-recipe/v1/collections/4');
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 response = await fetch('https://your-site.example/wp-json/plugixa-recipe/v1/collections/4', {
  headers: {
    'Authorization': auth,
  },
});
const { data } = await response.json();

Quick Links

Share