Search Users
zammad.search_users
ActionBusiness appsconnection required
Calls the Zammad API with the connection's credentials.
Find users by name, email address or login.
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
4 fields, 1 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 |
|---|---|---|---|---|---|
query What to search for: part of a name, an email address or a login. | string | Yes | — | — | david@example.com |
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,
"query": "david@example.com"
}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 user's numeric id. | number | — |
items[].login The user's login. | string | — |
items[].email The user's email address. | string | — |
items[].firstname The user's first name. | string | — |
items[].lastname The user's last name. | string | — |
items[].organization_id Id of the organization the user belongs to. | number | — |
items[].role_ids Ids of the roles the user holds. | array | — |
items[].active True while the account is active. | boolean | — |
items[].created_at When the account was created, as an ISO 8601 stamp. | string | — |
{
"count": 0,
"items": [
{
"active": false,
"created_at": "",
"email": "",
"firstname": "",
"id": 0,
"lastname": "",
"login": "",
"organization_id": 0,
"role_ids": []
}
]
}See Search Users 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.