Sign in
latestOpenAPI 3.1.02026-08-10150311431.9 KB

c1f3c6d96b31

Recipes

List recipes

get/recipes

Query parameters

searchstring[]

You know, for search

You know, for search

namestring[]

The account name

The account name

ownerstring[]

Owner of the project

Owner of the project

publicboolean

Boolean check for public/private projects

Boolean check for public/private projects

keywordstring[]

A keyword to index the repository by

A keyword to index the repository by

permissionstring[]

Filter by permission on given resource

Filter by permission on given resource

sort_by'created_at' | 'updated_at' | 'name' | 'latest_tag'

An enumeration.

Key to sort the list by

sort_order'ascending' | 'descending'

An enumeration.

The order to sort the list

pageinteger

Page number starting from 1

Page number starting from 1

per-pageinteger

Number of items per page

Number of items per page

Response

Retrieved

pageinteger required

The current page the pagination request is on

per_pageinteger required

The number of pages per pagination request

next_pageinteger

The next page, if this on is not the last

page_countinteger required

The total number of pages

total_countinteger required

The total number of resources matching the list request

Example response

{
  "resources": [
    {
      "keywords": [
        "daylight",
        "radiance"
      ],
      "description": "Run daylight simulations the easy way!",
      "icon": "https://avatars1.githubusercontent.com/u/38131342",
      "name": "daylight-factor",
      "id": "5d5e7103-2c1e-413f-9332-f8ec4a9aace7",
      "latest_tag": "0.2.1",
      "owner": {
        "id": "0ad77f99-8043-46e4-8220-7221487c3ee5",
        "account_type": "user",
        "name": "ladybugbot",
        "display_name": "Ladybug Bot",
        "description": "Beep Boop!"
      },
      "permissions": {
        "read": true
      },
      "slug": "ladybug-tools/daylight-factor"
    }
  ]
}