Skip to main content
GET
/
expression
/
recipes
/
list
List recipes
curl --request GET \
  --url https://api.getcargo.io/v1/expression/recipes/list \
  --header 'Authorization: Bearer <token>'
{
  "recipes": [
    {
      "uuid": "<string>",
      "shortId": "<string>",
      "version": 123,
      "workspaceUuid": "<string>",
      "name": "<string>",
      "description": "<string>",
      "category": "other",
      "executionsCount": 123,
      "isPublic": true,
      "isBlacklisted": true,
      "archivedAt": "<string>",
      "placeholders": [
        {
          "slug": "<string>",
          "name": "<string>",
          "kind": "string",
          "description": "<string>"
        }
      ],
      "expression": "<string>",
      "instructTo": "ai",
      "kind": "jsExpression",
      "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

Successful response

recipes
Recipes · object[]
required

List of recipes.