list_groups
Retrieve and filter groups from ServiceNow using parameters like active status, group type, or search terms for group name and description. Supports pagination with limit and offset options.
Instructions
List groups from ServiceNow with optional filtering
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| active | No | Filter by active status | |
| limit | No | Maximum number of groups to return | |
| offset | No | Offset for pagination | |
| query | No | Case-insensitive search term that matches against group name or description fields. Uses ServiceNow's LIKE operator for partial matching. | |
| type | No | Filter by group type |
Input Schema (JSON Schema)
{
"description": "Parameters for listing groups.",
"properties": {
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by active status",
"title": "Active"
},
"limit": {
"default": 10,
"description": "Maximum number of groups to return",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Offset for pagination",
"title": "Offset",
"type": "integer"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Case-insensitive search term that matches against group name or description fields. Uses ServiceNow's LIKE operator for partial matching.",
"title": "Query"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Filter by group type",
"title": "Type"
}
},
"title": "ListGroupsParams",
"type": "object"
}