Sign in

v1

latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-06124404444.0 KB
Controls

Get a control

Returns info on a control.

get/docs/{docId}/controls/{controlIdOrName}

Path parameters

docIdstring required

ID of the doc.

controlIdOrNamestring required

ID or name of the control. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

Response

Details about a control.

idstring required

ID of the control.

type'control' required

The type of this resource.

hrefstring url required

API link to the control.

namestring required

Name of the control.

controlType'aiBlock' | 'button' | 'checkbox' | 'datePicker' | 'dateRangePicker' | 'dateTimePicker' | 'lookup' | 'multiselect' | 'select' | 'scale' | 'slider' | 'reaction' | 'textbox' | 'timePicker' required

Type of the control.

Example response

{
  "id": "ctrl-cDefGhij",
  "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/controls/ctrl-cDefGhij",
  "name": "Cost",
  "parent": {
    "id": "canvas-IjkLmnO",
    "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO",
    "browserLink": "https://docs.superhuman.com/d/_dAbCDeFGH/Launch-Status_sumnO",
    "name": "Launch Status"
  },
  "controlType": "slider",
  "value": "$12.34"
}