Zum Inhalt
Für Agenten

group_list

List Groups

Markdown Tools als JSON

Beschreibung

Lists member groups in the account. Groups are a primitive for scoping (channel access, document sharing, project visibility) — no ACL surfaces consume them yet, but the IDs returned here are stable and safe to attach to future permission rows.

Soft-deleted (archived) groups are excluded by default; pass include_archived: true to surface them as well.

Zugriff

Zugriffsprofil: gated. Module: none. Die Freigabe im Profil ersetzt keine Account-, Workspace- oder Rollenberechtigung.

Parameter

Name Typ Pflicht Beschreibung
account_id string Ja
include_archived boolean Nein

Eingabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "include_archived": {
      "type": "boolean",
      "default": false
    }
  },
  "required": [
    "account_id"
  ],
  "type": "object"
}

Ausgabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Group prefix ID (grp_…)."
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "member_count": {
            "type": "integer"
          },
          "archived": {
            "type": "boolean"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          }
        },
        "required": [
          "id",
          "name",
          "member_count",
          "archived",
          "created_at"
        ]
      }
    }
  },
  "required": [
    "groups"
  ],
  "type": "object"
}
Seiten