contentControls.list

Summary

List all content controls in the document with optional type/tag filtering.

Operation ID: contentControls.list
API member path: editor.doc.contentControls.list(...)
Mutates document: no
Idempotency: idempotent
Supports tracked mode: no
Supports dry run: no
Deterministic target resolution: yes

Expected result

Returns a ContentControlsListResult with items and total count.

Input fields

Field	Type	Required
`controlType`	string	no
`limit`	integer	no
`offset`	integer	no
`tag`	string	no

Example request

{
  "controlType": "example",
  "tag": "example"
}

Output fields

Field	Type	Required	Description
`items`	object[]	yes
`total`	integer	yes

Example response

{
  "items": [
    {}
  ],
  "total": 1
}

Pre-apply throws

TARGET_NOT_FOUND
INVALID_INPUT
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "controlType": {
      "type": "string"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "tag": {
      "type": "string"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "items": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "total": {
      "type": "integer"
    }
  },
  "required": [
    "items",
    "total"
  ],
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

contentControls.list

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas