List recipes

The account’s recipes (drafts included), optionally with the recipes other accounts made public. Page size is fixed at 50.

Requires the library:read permission.

GET/recipes

Autorización

AuthorizationToken Bearer (API Key) · headerobligatorio

Almendra API key, bound to one professional account. Send it as Authorization: Bearer YOUR_API_KEY.

Ámbitos:library:read

Parámetros de consulta

pageinteger

Page number (starts at 1)

mín. 0 · predeterminado: 1

searchstring

Recipe name (accents and case are ignored)

longitud mín. 1 · longitud máx. 70

includePublicstring

Also list finished recipes other accounts made public (defaults to only the account's own)

predeterminado: "false"

Valores permitidos:truefalse

Respuestas

200

Recipes

recipesRecipeSummary[]obligatorio

Mostrar propiedades

Array de RecipeSummary

_idstringobligatorio

namestringobligatorio

portionsnumber

preparationTimeMinutesnumber

cookingTimeMinutesnumber

caloriesKcalnumber

proteinGnumber

carbsGnumber

fatGnumber

tagsstring[]obligatorio

imageUrlstring

isPublicbooleanobligatorio

Shared with every Almendra account

isDraftbooleanobligatorio

Still being written (not yet offered in meal plans)

createdByThisAccountbooleanobligatorio

pageintegerobligatorio

mín. 0

pageSizeintegerobligatorio

mín. 0

totalCountintegerobligatorio

totalPagesintegerobligatorio

400

Invalid path parameter, query parameter or request body

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

Valores permitidos:bad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictpayload_too_largeunsupported_media_typeunprocessable_entityrate_limitedinternal_errornot_implementedbad_gatewayservice_unavailablegateway_timeout

messagestringobligatorio

Human-readable explanation of what went wrong.

401

Missing or invalid API key

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

403

The account behind the API key has no active paid plan, or the key lacks the permission this operation needs

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

429

Rate limit exceeded (600 requests per 60 seconds); retry after Retry-After seconds

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

500

Unexpected server error

successbooleanobligatorio

Valores permitidos:false

messagestringobligatorio

Same as error.message.

errorobjectobligatorio

Mostrar propiedades

statusintegerobligatorio

HTTP status code of the response.

codestringobligatorio

Machine-readable error code, stable across versions; branch on this rather than on message.

messagestringobligatorio

Human-readable explanation of what went wrong.

Pruébalo

Servidor

URL baseURL base personalizadaSi se define, sustituye al servidor seleccionado.

Autorización

Token Bearer (API Key)Recordar en este dispositivoIncluir mis valores en los ejemplos

Parámetros

pagequeryPage number (starts at 1)searchqueryRecipe name (accents and case are ignored)includePublicqueryAlso list finished recipes other accounts made public (defaults to only the account's own)

Solicitud

curl -X GET 'https://api.almendra.io/openapi/v1/recipes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response: Response = await fetch("https://api.almendra.io/openapi/v1/recipes", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import axios from "axios";

const response = await axios.request({
  method: "GET",
  url: "https://api.almendra.io/openapi/v1/recipes",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.almendra.io/openapi/v1/recipes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Respuesta

{
  "recipes": [
    {
      "_id": "string",
      "name": "Quinua con pollo",
      "portions": 0,
      "preparationTimeMinutes": 0,
      "cookingTimeMinutes": 0,
      "caloriesKcal": 0,
      "proteinG": 0,
      "carbsG": 0,
      "fatG": 0,
      "tags": [
        "string"
      ],
      "imageUrl": "string",
      "isPublic": true,
      "isDraft": true,
      "createdByThisAccount": true
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalCount": 150,
  "totalPages": 3
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

{
  "success": false,
  "message": "string",
  "error": {
    "status": 404,
    "code": "not_found",
    "message": "Patient not found"
  }
}

List recipes

¿No encuentras lo que buscas?