Noroff API Documentation

Some of these are authenticated endpoints. You can visit authentication to register an account.

These endpoints allow you to create, read, update and delete recipes. Recipes are the core resource of the Smart Recipe Book — anyone can browse and read them, but creating, updating and deleting requires authentication and ownership.

These endpoints support pagination and sorting. Read more about these features here.

The Recipe model

Prop	Type	Default
`id`	`string`	-
`title`	`string`	-
`description`	`string`	-
`prepTime`	`integer`	-
`cookTime`	`integer`	-
`servings`	`integer`	-
`difficulty`	`string`	-
`category`	`string`	-
`ingredients`	`Array<object>`	-
`instructions`	`Array<string>`	-
`tags`	`Array<string>`	-
`image`	`object`	-
`owner`	`Profile`	-
`comments`	`Array<Comment>`	-
`_count`	`object`	-
`created`	`Date`	-
`updated`	`Date`	-

The Recipe Comment model

Prop	Type	Default
`id`	`string`	-
`text`	`string`	-
`recipeId`	`string`	-
`author`	`Profile`	-
`created`	`Date`	-
`updated`	`Date`	-

Query parameters

The following optional query parameters can be used to filter recipes.

Prop	Type	Default
`search`	`string`	-
`category`	`string`	-
`difficulty`	`string`	-

Get all recipes

GET/recipe-book/recipes

Retrieve all recipes. Supports filtering by search, category, and difficulty query parameters.

Response

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Classic Margherita Pizza",
      "description": "A simple and delicious homemade pizza with fresh basil.",
      "prepTime": 20,
      "cookTime": 15,
      "servings": 4,
      "difficulty": "Easy",
      "category": "Dinner",
      "ingredients": [
        { "name": "Pizza dough", "quantity": 1, "unit": "ball" },
        { "name": "Tomato sauce", "quantity": 0.5, "unit": "cup" },
        { "name": "Fresh mozzarella", "quantity": 200, "unit": "g" },
        { "name": "Fresh basil", "quantity": 6, "unit": "leaves" }
      ],
      "instructions": [
        "Preheat oven to 250C.",
        "Roll out the pizza dough on a floured surface.",
        "Spread tomato sauce evenly over the dough.",
        "Tear mozzarella into pieces and distribute over sauce.",
        "Bake for 12-15 minutes until crust is golden.",
        "Top with fresh basil leaves and serve immediately."
      ],
      "tags": ["Italian", "Vegetarian", "Quick"],
      "image": {
        "url": "https://example.com/pizza.jpg",
        "alt": "Margherita pizza"
      },
      "owner": {
        "name": "jane_doe",
        "email": "jane@stud.noroff.no",
        "bio": null,
        "avatar": {
          "url": "https://example.com/avatar.jpg",
          "alt": "Jane's avatar"
        },
        "banner": {
          "url": "https://example.com/banner.jpg",
          "alt": "Jane's banner"
        }
      },
      "comments": [
        {
          "id": "comment-id",
          "text": "Made this last night, amazing!",
          "author": {
            "name": "john_doe",
            "email": "john@stud.noroff.no"
          },
          "created": "2026-03-12T14:00:00.000Z",
          "updated": "2026-03-12T14:00:00.000Z"
        }
      ],
      "_count": {
        "favorites": 3
      },
      "created": "2026-03-12T10:30:00.000Z",
      "updated": "2026-03-12T10:30:00.000Z"
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 1
  }
}

Get single recipe

GET/recipe-book/recipes/<id>

Retrieve a single recipe by its id, including all associated comments and favorite count.

Response

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Classic Margherita Pizza",
    "description": "A simple and delicious homemade pizza with fresh basil.",
    "prepTime": 20,
    "cookTime": 15,
    "servings": 4,
    "difficulty": "Easy",
    "category": "Dinner",
    "ingredients": [
      { "name": "Pizza dough", "quantity": 1, "unit": "ball" },
      { "name": "Tomato sauce", "quantity": 0.5, "unit": "cup" },
      { "name": "Fresh mozzarella", "quantity": 200, "unit": "g" },
      { "name": "Fresh basil", "quantity": 6, "unit": "leaves" }
    ],
    "instructions": [
      "Preheat oven to 250C.",
      "Roll out the pizza dough on a floured surface.",
      "Spread tomato sauce evenly over the dough.",
      "Tear mozzarella into pieces and distribute over sauce.",
      "Bake for 12-15 minutes until crust is golden.",
      "Top with fresh basil leaves and serve immediately."
    ],
    "tags": ["Italian", "Vegetarian", "Quick"],
    "image": {
      "url": "https://example.com/pizza.jpg",
      "alt": "Margherita pizza"
    },
    "owner": {
      "name": "jane_doe",
      "email": "jane@stud.noroff.no",
      "bio": null,
      "avatar": {
        "url": "https://example.com/avatar.jpg",
        "alt": "Jane's avatar"
      },
      "banner": {
        "url": "https://example.com/banner.jpg",
        "alt": "Jane's banner"
      }
    },
    "comments": [],
    "_count": {
      "favorites": 3
    },
    "created": "2026-03-12T10:30:00.000Z",
    "updated": "2026-03-12T10:30:00.000Z"
  },
  "meta": {}
}

Create recipe

POST/recipe-book/recipes

Create a new recipe. Only authenticated users can create recipes.

Please note that the image.url property must be a fully formed URL that links to a live and publicly accessible image. The API will check the provided URL and if it cannot be accessed publicly you will receive a 400 Bad Request error response.

Request

{
  "title": "Classic Margherita Pizza",
  "description": "A simple and delicious homemade pizza with fresh basil.",
  "prepTime": 20,
  "cookTime": 15,
  "servings": 4,
  "difficulty": "Easy",
  "category": "Dinner",
  "ingredients": [
    { "name": "Pizza dough", "quantity": 1, "unit": "ball" },
    { "name": "Tomato sauce", "quantity": 0.5, "unit": "cup" },
    { "name": "Fresh mozzarella", "quantity": 200, "unit": "g" },
    { "name": "Fresh basil", "quantity": 6, "unit": "leaves" }
  ],
  "instructions": [
    "Preheat oven to 250C.",
    "Roll out the pizza dough on a floured surface.",
    "Spread tomato sauce evenly over the dough.",
    "Tear mozzarella into pieces and distribute over sauce.",
    "Bake for 12-15 minutes until crust is golden.",
    "Top with fresh basil leaves and serve immediately."
  ],
  "tags": ["Italian", "Vegetarian"],
  "image": {
    "url": "https://example.com/pizza.jpg",
    "alt": "Margherita pizza"
  }
}

Response

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Classic Margherita Pizza",
    "description": "A simple and delicious homemade pizza with fresh basil.",
    "prepTime": 20,
    "cookTime": 15,
    "servings": 4,
    "difficulty": "Easy",
    "category": "Dinner",
    "ingredients": [
      { "name": "Pizza dough", "quantity": 1, "unit": "ball" },
      { "name": "Tomato sauce", "quantity": 0.5, "unit": "cup" },
      { "name": "Fresh mozzarella", "quantity": 200, "unit": "g" },
      { "name": "Fresh basil", "quantity": 6, "unit": "leaves" }
    ],
    "instructions": [
      "Preheat oven to 250C.",
      "Roll out the pizza dough on a floured surface.",
      "Spread tomato sauce evenly over the dough.",
      "Tear mozzarella into pieces and distribute over sauce.",
      "Bake for 12-15 minutes until crust is golden.",
      "Top with fresh basil leaves and serve immediately."
    ],
    "tags": ["Italian", "Vegetarian"],
    "image": {
      "url": "https://example.com/pizza.jpg",
      "alt": "Margherita pizza"
    },
    "owner": {
      "name": "jane_doe",
      "email": "jane@stud.noroff.no",
      "bio": null,
      "avatar": null,
      "banner": null
    },
    "comments": [],
    "_count": {
      "favorites": 0
    },
    "created": "2026-03-12T10:30:00.000Z",
    "updated": "2026-03-12T10:30:00.000Z"
  },
  "meta": {}
}

Update recipe

PUT/recipe-book/recipes/<id>

Update a recipe by its id. Only the owner of the recipe can update it. You must provide at least one field to update.

Request

// You can update any combination of the properties of the recipe.
{
  "title": "Updated Margherita Pizza",
  "servings": 6,
  "tags": ["Italian", "Vegetarian", "Family"]
}

Response

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "Updated Margherita Pizza",
    "description": "A simple and delicious homemade pizza with fresh basil.",
    "prepTime": 20,
    "cookTime": 15,
    "servings": 6,
    "difficulty": "Easy",
    "category": "Dinner",
    "ingredients": [
      { "name": "Pizza dough", "quantity": 1, "unit": "ball" },
      { "name": "Tomato sauce", "quantity": 0.5, "unit": "cup" },
      { "name": "Fresh mozzarella", "quantity": 200, "unit": "g" },
      { "name": "Fresh basil", "quantity": 6, "unit": "leaves" }
    ],
    "instructions": [
      "Preheat oven to 250C.",
      "Roll out the pizza dough on a floured surface.",
      "Spread tomato sauce evenly over the dough.",
      "Tear mozzarella into pieces and distribute over sauce.",
      "Bake for 12-15 minutes until crust is golden.",
      "Top with fresh basil leaves and serve immediately."
    ],
    "tags": ["Italian", "Vegetarian", "Family"],
    "image": {
      "url": "https://example.com/pizza.jpg",
      "alt": "Margherita pizza"
    },
    "owner": {
      "name": "jane_doe",
      "email": "jane@stud.noroff.no",
      "bio": null,
      "avatar": null,
      "banner": null
    },
    "comments": [],
    "_count": {
      "favorites": 0
    },
    "created": "2026-03-12T10:30:00.000Z",
    "updated": "2026-03-12T10:45:00.000Z"
  },
  "meta": {}
}

Delete recipe

DELETE/recipe-book/recipes/<id>

Delete a recipe by its id. Only the owner of the recipe can delete it. This will also delete all associated comments, favorites, and meal plan entries.

Returns an empty 204 No Content response on success.

Get recipe comments

GET/recipe-book/recipes/<recipeId>/comments

Retrieve all comments for a specific recipe. This endpoint does not require authentication.

Response

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "text": "Made this last night, it was amazing!",
      "recipeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "author": {
        "name": "john_doe",
        "email": "john@stud.noroff.no",
        "bio": null,
        "avatar": null,
        "banner": null
      },
      "created": "2026-03-12T14:00:00.000Z",
      "updated": "2026-03-12T14:00:00.000Z"
    }
  ],
  "meta": {}
}

Create recipe comment

POST/recipe-book/recipes/<recipeId>/comments

Add a comment to a recipe. Only authenticated users can create comments.

Request

{
  "text": "Made this last night, it was amazing!"
}

Response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "text": "Made this last night, it was amazing!",
    "recipeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "author": {
      "name": "john_doe",
      "email": "john@stud.noroff.no",
      "bio": null,
      "avatar": null,
      "banner": null
    },
    "created": "2026-03-12T14:00:00.000Z",
    "updated": "2026-03-12T14:00:00.000Z"
  },
  "meta": {}
}

Recipes

On this page