List Organizations
zammad.list_organizations
ActionBusiness appsconnection required
Calls the Zammad API with the connection's credentials.
Read the organizations this token can see.
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 organization's numeric id. | number | — |
items[].name The organization's name. | string | — |
items[].domain Email domain the organization is recognised by. | string | — |
items[].domain_assignment True when that domain auto-assigns members. | boolean | — |
items[].shared True when members can see each other's tickets. | boolean | — |
items[].vip True when the organization is flagged as VIP. | boolean | — |
items[].active True while the organization is active. | boolean | — |
items[].note The organization's note. | string | — |
items[].member_ids Ids of the users in the organization. | array | — |
{
"count": 0,
"items": [
{
"active": false,
"domain": "",
"domain_assignment": false,
"id": 0,
"member_ids": [],
"name": "",
"note": "",
"shared": false,
"vip": false
}
]
}See List Organizations 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.