TRMNL Octri Demo
GET/api/plugin_settings/{plugin_setting_id}/refreshes/{id}

Get the result of a plugin setting refresh

Retrieves the result of a refresh for a plugin setting. Use the id returned when you started the refresh to check whether it has finished. The response includes the fetched variables and refresh details, or a pending status while processing continues.

2 parameters
plugin_setting_idstringrequired
The plugin setting's ID or UUID for the refresh.
idstringrequired
The refresh job ID returned when you started the refresh.

5 status codes
200Returns the freshly fetched variables along with refresh details, including the job ID, logs, status, and any warning.
dataobjectoptional
202Returns the refresh job's current ID and status while the refresh is still processing.
dataobjectoptional
401Returned when authentication is missing or invalid.
errorstringoptional
404Returned when the requested UUID belongs to another user.
410Returned when the result has expired or the job ID was never issued.

Error handling

A 401 is returned when authentication is missing or invalid. A 404 is returned when the requested UUID belongs to another user; a 410 is returned when the result has expired or the id path parameter was never issued. The plugin_setting_id path parameter must identify the plugin setting used to start the refresh, and id must be the returned refresh job ID.