GEgetsitecontrol
Widgets

Get a widget

One widget with everything List widgets gives, plus its content (pages, texts, fields, buttons), the notification_emails its responses are sent to, and who created and last edited it.

get/v1/sites/{site_id}/widgets/{widget_id}

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
widget_idinteger required

Widget id from List widgets

Response

Successful Response

idinteger required
namestring nullable
headlinestring nullable

The widget's first headline, plain text; null when it has none

layout'modal' | 'bar' | 'panel' | 'slide_in' | 'sidebar' | 'fullscreen' | 'inline' | 'other' required

Where the widget sits on the page, named as in the admin. modal: a window centred over the page. bar: a strip across the top or bottom of the page. panel: a box attached to the bottom of the screen, opened from its header. slide_in: a box that slides in from a corner. sidebar: a panel attached to the left or right edge of the screen. fullscreen: covers the whole screen. inline: placed inside the page content. other: a layout the admin no longer offers. "Pop-up" is not a layout: users call any widget a pop-up.

is_activeboolean required
actionsstring[] required

Event types the widget can produce besides show and close

warningsstring[] required

Informational notes about the widget itself; wording is not stable, do not parse

created_atstring date-time nullable
updated_atstring date-time nullable

Last change of the widget itself; a move to another folder does not change it

edited_atstring date-time nullable

Last change made in the editor

truncatedstring[]

Parts shortened in the list, as paths; the card has them whole. Empty when nothing was cut

notification_emailsstring[] required

Where responses are e-mailed; whether they are is features.notifications

Changes

No recorded changes to this operation across all 1 revision of this API.