List Groups

zammad.list_groups

ActionBusiness appsconnection required

Calls the Zammad API with the connection's credentials.

Read the groups a ticket can be routed to.

Ask about Zammad All Zammad nodes Provider API docs ↗

Connection

Required: Yes — the node will not save without one
Auth type: API key
Providers: Zammad
Secret shape: the API token, or {"api_token": "…"}
Config it needs: base_url
Resolved by: config.connection_id, else node.connection_id

Configuration

3 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

Field	Type	Required	Default	Constraints	Example
page Which page of results to read, counting from 1.	number	No	1	≥ 1	—
per_page How many records to return per page.	number	No	50	≥ 1	—
expand Ask Zammad to resolve the association ids into names alongside them.	boolean	No	false	—	—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "expand": false,
  "page": 1,
  "per_page": 50
}

Output

One shape.

result

Field	Type	Example
items The records Zammad returned for this page.	array	—
count How many records this page carried.	number	—
items[].id The group's numeric id.	number	—
items[].name The group's name, which is what a ticket's 'group' takes.	string	—
items[].email_address_id Id of the email address the group sends from.	number	—
items[].signature_id Id of the signature the group appends.	number	—
items[].assignment_timeout Minutes before an assignment is released.	number	—
items[].follow_up_possible Whether a closed ticket can be followed up.	string	—
items[].follow_up_assignment True when a follow-up reassigns the owner.	boolean	—
items[].active True while the group is active.	boolean	—
items[].user_ids Ids of the agents in the group.	array	—

{
  "count": 0,
  "items": [
    {
      "active": false,
      "assignment_timeout": 0,
      "email_address_id": 0,
      "follow_up_assignment": false,
      "follow_up_possible": "",
      "id": 0,
      "name": "",
      "signature_id": 0,
      "user_ids": []
    }
  ]
}

Notes

Listing groups needs the admin.group permission on the token's account.

Related Zammad nodes

See List Groups run in a workflow.

In a technical demo we add the Zammad connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demo Talk to sales