Search Tickets

zammad.search_tickets
ActionBusiness appsconnection required

Calls the Zammad API with the connection's credentials.

Search tickets with a Zammad search query.

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.

FieldTypeRequiredDefaultConstraintsExample
query
The search query, in Zammad's own search syntax — a bare word, or a field query such as state.name:open AND group.name:Users.
stringYes——state.name:open
page
Which page of results to read, counting from 1.
numberNo1≥ 1—
per_page
How many records to return per page.
numberNo50≥ 1—
expand
Ask Zammad to resolve the association ids into names alongside them.
booleanNofalse——

Example configuration

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

{
  "expand": false,
  "page": 1,
  "per_page": 50,
  "query": "state.name:open"
}

Output

One shape.

result

FieldTypeExample
items
The records Zammad returned for this page.
array—
count
How many records this page carried.
number—
items[].id
The ticket's numeric id.
number—
items[].number
The ticket number people quote, such as '67001'.
string—
items[].title
The ticket's title.
string—
items[].group_id
Id of the group the ticket is routed to.
number—
items[].state_id
Id of the ticket's state.
number—
items[].priority_id
Id of the ticket's priority.
number—
items[].owner_id
Id of the agent the ticket is assigned to.
number—
items[].customer_id
Id of the customer the ticket belongs to.
number—
items[].organization_id
Id of the customer's organization.
number—
items[].created_at
When the ticket was opened, as an ISO 8601 stamp.
string—
items[].updated_at
When the ticket last changed, as an ISO 8601 stamp.
string—
items[].article_ids
Ids of the articles on the ticket.
array—
{
  "count": 0,
  "items": [
    {
      "article_ids": [],
      "created_at": "",
      "customer_id": 0,
      "group_id": 0,
      "id": 0,
      "number": "",
      "organization_id": 0,
      "owner_id": 0,
      "priority_id": 0,
      "state_id": 0,
      "title": "",
      "updated_at": ""
    }
  ]
}

See Search Tickets 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.