guild_get_prune_count
guild_get_prune_count
Section titled “guild_get_prune_count”Category: guild
Preview how many members would be pruned (kicked) for inactivity.
When to use
Section titled “When to use”- Estimate impact before calling
guild_begin_prune.
days (1..30) is the inactivity threshold. include_roles scopes prune to members holding ALL listed roles (max 100).
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild to query |
days | integer | no | Inactivity threshold in days (1..30, default 7) |
include_roles | array | no | Members must have ALL these roles to be eligible |
Returns
Section titled “Returns”\{pruned\} (estimated kick count).
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
pruned | integer | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |