Read the markup of a recipe | TRMNL Octri Demo

2 parameters

idintegerrequired

Recipe id

sizesstringoptional

Comma-separated markup sizes to read, default all: markup_full, markup_half_horizontal, markup_half_vertical, markup_quadrant, shared_markup

4 status codes

200Success

dataobjectoptional

401Unauthorized

errorstringoptional

404Not a published recipe

422A size that does not exist

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Not a published recipe. A 422 is returned: A size that does not exist.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.markup.list({
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  sizes: "example",
});

{
  "data": {
    "custom_fields": [
      {}
    ],
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "strategy": "example_value"
  }
}

Request

Response

Errors