latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-19124404444.2 KB

22273737ad50

Controls

List controls

Returns a list of controls in a document.

get/docs/{docId}/controls

Path parameters

docIdstring required

ID of the doc.

Query parameters

limitinteger

Maximum number of results to return in this query.

pageTokenstring

An opaque token used to fetch the next page of results.

sortBy'name'

Determines how the objects returned are sorted

Determines how to sort the given objects.

Response

List of controls in a doc.

hrefstring url

API link to these results

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "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"
      }
    }
  ],
  "href": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/controls?limit=20",
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/docs/AbCDeFGH/controls?pageToken=eyJsaW1pd"
}