list-annotations

dci list-annotations [flags]

Returns a list of annotations that your account has access to. Annotations are listed in reverse chronological order by default.

CLI default view

dci list-annotations presents a curated table by default:

Columns: content, labels (label names, comma-joined), reports (report ids resolved to report names, comma-joined), and annotated (UTC) (from timestamp).
In interactive tables, annotated (UTC) renders in your local timezone and is titled annotated (local); machine formats, agent mode, and --utc keep UTC — see Timestamps and timezones.
--output json and explicit -C/--fields selections return the raw fields documented below.

Flags

--max-results: (integer format:int64 default:50)

--page-token: (string)

--filter: (string)

--sort-by: (string enum:"id","content","timestamp","timeCreated","timeModified")

--sort-order: (string enum:"asc","desc")

Output

OK - The request succeeded.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
`pageToken`	string	Page token, returned by a previous call, to request the next page of results
`rowCount`	integer	Total number of annotations in the result set
`annotations`	array of object
`annotations[].id`	string	The unique identifier of the annotation.
`annotations[].content`	string	The content of the annotation.
`annotations[].timestamp`	string (date-time)	The date associated with the annotation.
`annotations[].reports`	array of string	List of report IDs associated with the annotation.
`annotations[].labels`	array of object	List of labels associated with the annotation.
`annotations[].labels[].id`	string	The unique identifier of the label.
`annotations[].labels[].name`	string	The name of the label.
`annotations[].createTime`	string (date-time)	The creation time of the annotation.
`annotations[].updateTime`	string (date-time)	The time when the annotation was last updated.

Raw JSON schema

{
  "type": "object",
  "properties": {
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results"
    },
    "rowCount": {
      "type": "integer",
      "description": "Total number of annotations in the result set"
    },
    "annotations": {
      "type": "array",
      "items": {
        "required": [
          "id",
          "content",
          "timestamp"
        ],
        "type": "object",
        "description": "Summary information about an annotation.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the annotation."
          },
          "content": {
            "type": "string",
            "description": "The content of the annotation."
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "The date associated with the annotation."
          },
          "reports": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of report IDs associated with the annotation."
          },
          "labels": {
            "type": "array",
            "items": {
              "required": [
                "id",
                "name"
              ],
              "type": "object",
              "description": "Metadata for a label.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "The unique identifier of the label."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the label."
                }
              }
            },
            "description": "List of labels associated with the annotation."
          },
          "createTime": {
            "type": "string",
            "format": "date-time",
            "description": "The creation time of the annotation."
          },
          "updateTime": {
            "type": "string",
            "format": "date-time",
            "description": "The time when the annotation was last updated."
          }
        }
      }
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status	Exit code	Error code	Meaning
400	30	`VALIDATION_ERROR`	The arguments or request body were rejected. Review the command's flags and payload.
401	10	`AUTHENTICATION_FAILED`	Not signed in, or the API token is invalid. Run `dci login` or check `DCI_API_KEY`.
403	11	`PERMISSION_DENIED`	The DoiT user or the active customer context does not have access.
404	20	`RESOURCE_NOT_FOUND`	The requested resource does not exist. Check the identifier argument.

Aliases: listannotations

Flags​

Output​

Errors​

Flags

Output

Errors