Program list

GET 
https://app.connectedcooking.com/api/public/cooking-programs

Returns a paginated list of cooking programs.

Request

Query Parameters

groupId number
Id of the group and subgroups to filter devices for.
Example: 1
deviceFamilyIds array
Possible values: [1, 2, 15, 16, 33]
Filter devices by their device family. See Device family list for more details.
Example: 15
search string
Filter devices by the provided search string (applicable fields name, serialNumber).
Example: MyDevice1
sort string
Possible values: [id.asc, id.desc, uuid.asc, uuid.desc, type.asc, type.desc, status.asc, status.desc]
The property and direction the list should be sorted. Sort directions are .asc or .desc.
Example: status,asc
page number
The index of the page.
Example: 1
size number
Possible values: >= 1 and <= 100
The number of entries to return per page.
Default value: 20
Example: 20

Responses

200

Response Headers

x-total-count
The number of total cooking programs
Example: 69
link
Pagination links for first, last and next page.
Example: </api/public/cooking-programs?page=1&size=20>; rel="next",</api/public/cooking-programs?page=7&size=20>; rel="last",</api/public/cooking-programs?page=0&size=20>; rel="first"

application/json

Schema

Schema

• Array [
idnumber

The unique id.

uuidstring

Unique identifier for the program.

namestring

The name of the program.

typestring

The type of the cooking program.

Possible values: [MANUAL, INTELLIGENT]

groupIdnumber

The id of the parent group.

deviceFamilyIdstring

The id of the family of the cooking program.

statusstring

The current review status of the cooking program.

Possible values: [created, review, published]

• ]

Example (auto)

[
  {
    "id": 0,
    "uuid": "string",
    "name": "string",
    "type": "MANUAL",
    "groupId": 0,
    "deviceFamilyId": "string",
    "status": "created"
  }
]

Single program

A single cooking program

[
  {
    "id": 11,
    "uuid": "e504fa7b-bfc0-46d0-ba33-3de7395d8493",
    "name": "My little program",
    "type": "INTELLIGENT",
    "groupId": 1,
    "deviceFamilyId": 1,
    "simulated": "review"
  }
]

Multiple programs

A single cooking program

[
  {
    "id": 11,
    "uuid": "e504fa7b-bfc0-46d0-ba33-3de7395d8493",
    "name": "My little program",
    "type": "INTELLIGENT",
    "groupId": 1,
    "deviceFamilyId": 1,
    "simulated": "review"
  },
  {
    "id": 12,
    "uuid": "12740e70-00d3-467c-9c08-0920ee25dde3",
    "name": "My large program",
    "type": "MANUAL",
    "groupId": 2,
    "deviceFamilyId": 2,
    "imageUrl": "https://app.connectedcooking.com/storage/cooking/images/cookingprograms/a9eafadd-12f3-44b7-9c4d-9a31c60914e9-full.png",
    "thumbnailUrl": "https://app.connectedcooking.com/storage/cooking/images/cookingprograms/a9eafadd-12f3-44b7-9c4d-9a31c60914e9.png",
    "simulated": "published"
  }
]

401

Invalid or expired access token

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWTdescription: The `access token` of the `API client` you requested with `/access`.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://app.connectedcooking.com/api/public/cooking-programs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://app.connectedcooking.com

Auth

Bearer Token

Parameters

groupId — query

deviceFamilyIds — query

search — query

sort — query

---id.ascid.descuuid.ascuuid.desctype.asctype.descstatus.ascstatus.desc

page — query

size — query

ResponseClear

Click the Send API Request button above and see the response here!