Documentation by ClonePartner

Start typing to search.

API Reference

Resolve picker options for an input widget

View Markdown
POST /api/dashboards/{id}/widgets/{widgetId}/options

Resolves one page of options from the widget's options_source via a readonly connector call, with server-side search (q) and cursor paging. side selects the source: 'source' | 'target' (field_mapping) or a field key (form). Returns a single page + next_cursor.

Operation IDresolveDashboardWidgetOptions

Authentication

  • BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

widgetIdstringrequired

Request body

Content typeapplication/json

requestobject

side selects the option source: 'source' | 'target' for a field_mapping widget, or a field key for a form widget. q is server-side search, cursor is the pagination cursor (omit for the first page). value is the current draft widget value, used by dependent form option sources.

4 properties
sidestring
qstring
cursorstring
valueunknown

Current draft value for this input widget.

Success response body

200One page of options

One page of options

Content typeapplication/json

responseobject
2 properties
optionsarray<WidgetOption>required
Array items
itemobject
3 properties
labelstringrequired
valuestringrequired
subTextstring
next_cursorstring | nullrequired
Nullable
yes

Error responses

400Validation error

Validation error

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input"
}

404Resource not found

Resource not found

Content typeapplication/json

responseobject
2 properties
errorstring
Example
NOT_FOUND
messagestring
Example
Resource not found
Example response
{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}