List recipes

List all expression recipes

GET /expression/recipes/list

List recipes

cURL

curl --request GET \
  --url https://api.getcargo.io/v1/expression/recipes/list \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getcargo.io/v1/expression/recipes/list"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getcargo.io/v1/expression/recipes/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/expression/recipes/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/expression/recipes/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getcargo.io/v1/expression/recipes/list")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/expression/recipes/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "recipes": [
    {
      "uuid": "<string>",
      "shortId": "<string>",
      "version": 123,
      "workspaceUuid": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isPublic": true,
      "isBlacklisted": true,
      "archivedAt": "<string>",
      "placeholders": [
        {
          "slug": "<string>",
          "name": "<string>",
          "description": "<string>"
        }
      ],
      "expression": "<string>",
      "userUuid": "<string>",
      "userFirstName": "<string>",
      "userLastName": "<string>",
      "userPicture": "<string>",
      "isFavorite": true
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

uiTypes · enum<string>[]

UI types to include.

Available options: ai, js

tab · enum<string>

Recipe tab filter.

Available options: all, user, workspace, favorites

categories · enum<string>[]

Recipe categories to include.

Available options: other, classification, cleaning, marketing, sales, event, copywriting

name · string

Filter recipes by name.

limit · string

Maximum number of recipes to return.

offset · string

Number of recipes to skip.

Response

200

application/json

Successful response

recipes · Recipes · object[] · required

List of recipes.

Show child attributes