Zum Inhalt
Für Agenten

group_get

Get Group

Markdown Tools als JSON

Beschreibung

Returns one group's metadata + every member. Useful before making a follow-up group_member_add / group_member_remove call so the agent can confirm the current roster.

Zugriff

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

Parameter

Name Typ Pflicht Beschreibung
account_id string Ja
id string Ja Group prefix ID (grp_…).

Eingabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "description": "Group prefix ID (grp_…)."
    }
  },
  "required": [
    "account_id",
    "id"
  ],
  "type": "object"
}

Ausgabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "group": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "archived": {
          "type": "boolean"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "members": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "User prefix ID or @handle."
              },
              "handle": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ]
          }
        }
      },
      "required": [
        "id",
        "name",
        "archived",
        "created_at",
        "members"
      ]
    }
  },
  "required": [
    "group"
  ],
  "type": "object"
}
Seiten