TRMNL Octri Demo
GET/api/plugin_settings/{plugin_setting_id}/markup/{size}

Read markup for a plugin setting size

Retrieves markup content for a plugin setting at the specified size. Choose a size value that identifies the markup format or canvas you need. The response includes the requested size and its markup content.

2 parameters
plugin_setting_idstringrequired
The plugin setting's ID or UUID.
sizestringrequired
The markup size to retrieve: `markup_full`, `markup_half_horizontal`, `markup_half_vertical`, `markup_quadrant`, `markup_shared`, `tidbyt_canvas`, `vestaboard_canvas`, or `transform_js`.
Allowed:markup_fullmarkup_half_horizontalmarkup_half_verticalmarkup_quadrantmarkup_sharedtidbyt_canvasvestaboard_canvastransform_js

4 status codes
200Returns the requested markup content, including the markup, shared markup, and size in the `data` object.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
404Returned when the UUID belongs to another user.
422Returned when `size` is invalid.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the UUID belongs to another user. A 422 is returned when size is invalid; use one of markup_full, markup_half_horizontal, markup_half_vertical, markup_quadrant, markup_shared, tidbyt_canvas, vestaboard_canvas, or transform_js. The plugin_setting_id path parameter must identify a plugin setting you can access.