core.cases.create_case
Create a new case.
Inputs
Dropdown selections to set on the case. Each item must include either definition_id or definition_ref, and either option_id or option_ref (or null to clear).Default:
null.The ID or short ID (e.g. CASE-0042) of a top-level case to create this case under as a sub-case. Requires the case add-ons entitlement.Default:
null.The priority of the case.Default:
"unknown".Allowed values: unknown, low, medium, high, critical, other.The severity of the case.Default:
"unknown".Allowed values: unknown, informational, low, medium, high, critical, fatal, other.The status of the case.Default:
"unknown".Allowed values: unknown, new, in_progress, on_hold, resolved, closed, other.Examples
Create a casecore.cases.get_case
Get details of a specific case by ID.
Inputs
Examples
Get a casecore.cases.update_case
Update an existing case.
Inputs
If true, append the provided description to the existing description when it is not empty.Default:
false.Dropdown selections to set or clear. Each item must include either definition_id or definition_ref, and either option_id or option_ref (or null to clear).Default:
null.List of tag identifiers (IDs or refs) to set on the case. This will replace all existing tags.Default:
null.Examples
Update case fieldscore.cases.list_cases
List all cases.
Inputs
The field to order by. Assignee uses lowercase email; tags uses the first normalized tag alphabetically. Missing values sort last.Default:
null.Return only these top-level payload keys, e.g. [‘alert_id’, ‘score’]. Automatically includes the subset regardless of include_payload. Dots are literal; selected objects are returned whole. Missing keys are omitted and null values preserved. An empty list acts as omitted; an empty string selects the literal empty key.Default:
null.Up to 100 nested object paths, e.g. [[‘alert’, ‘source’, ‘ip’]]. Each path contains 1 to 32 literal keys. Preserves nesting and combines with payload_fields, including the subset automatically. Selected parents include their whole value; missing paths are omitted and nulls preserved. Arrays are selected whole, without index traversal. An empty list is omitted.Default:
null.Examples
List casescore.cases.search_cases
Search cases based on various criteria.
Inputs
Users who created the case, as user IDs. ‘me’ needs a signed-in user, so it fails in workflows.Default:
null.Cases created in a window ending now, e.g. {‘amount’: 30, ‘unit’: ‘day’}. Units: hour, day, week, month. Cannot be combined with start_time/end_time.Default:
null.Shared AND/OR/NOT JSON filter tree. Tags use in/contains/is_null; scalar exclusions omit unset values unless ORed with is_null. Payload equality: {‘field’: ‘payload.metadata.product.vendor_name’, ‘op’: ‘eq’, ‘value’: ‘Microsoft’}. Payload paths support only eq/ne/is_null. Use dot-separated literal keys or numeric array indices; keys containing dots are unsupported. Combine with and/or/not; JSON scalar types are preserved. is_null matches missing paths, not explicit JSON null.Default:
null.The field to order by. Relevance requires search_mode=‘full_text’ and descending sort. Assignee uses lowercase email; tags uses the first normalized tag alphabetically. Missing values sort last.Default:
null.Return only these top-level payload keys, e.g. [‘alert_id’, ‘score’]. Automatically includes the subset regardless of include_payload. Dots are literal; selected objects are returned whole. Missing keys are omitted and null values preserved. An empty list acts as omitted; an empty string selects the literal empty key.Default:
null.Up to 100 nested object paths, e.g. [[‘alert’, ‘source’, ‘ip’]]. Each path contains 1 to 32 literal keys. Preserves nesting and combines with payload_fields, including the subset automatically. Selected parents include their whole value; missing paths are omitted and nulls preserved. Arrays are selected whole, without index traversal. An empty list is omitted.Default:
null.Search selected text fields; requires an explicit search_mode. Omitted searches both.Default:
null.Explicit words/phrases or escaped substring. Omitted preserves legacy matching.Default:
null.Filter by tag IDs or refs. Matches cases with any of the given tags.Default:
null.Cases updated in a window ending now, e.g. {‘amount’: 7, ‘unit’: ‘day’}. Cannot be combined with updated_after/updated_before.Default:
null.Run a saved case view (its UUID) or the built-in assigned_to_me view. The view replaces the matching criteria:
filters is ANDed with it and other matching inputs are rejected. Pass order_by to replace the view’s saved order; without it the view’s order applies and sort only sets the direction. Paging and result options still apply. A workflow has no signed-in user, so it can run shared views only, and views that use ‘me’, such as assigned_to_me, fail there.Default: null.Examples
Search casescore.cases.list_case_views
List built-in and shared saved case views.
Enterprise Edition
Returns the read-only built-in assigned_to_me view, unless
include_builtins is false, followed by shared saved views.
Workflows run without a signed-in user, so they can run shared views
only, and a view that filters on me fails. See
Case views.
Inputs
Examples
Run a shared case viewcore.cases.aggregate_cases
Filter, group, and summarize workspace cases. Returns groups and a truncated flag indicating whether more groups exist than the requested limit.
The example counts new and in_progress cases by priority and day.
It includes cases created on or after August 1, 2026 whose priority
is high or critical, or whose region is emea.
Before running it, create a TEXT custom case field named region.
Use ACTIONS.cases_by_priority_per_day.result.groups to read the results.
Each item contains a priority, a date, and a case count.
If ACTIONS.cases_by_priority_per_day.result.truncated is true,
the result reached the group limit and omitted some groups.
Inputs
Choose how to split cases into groups. Use up to 3 fields, or
[] for one total across all matching cases.Supply a field name such as priority, or an object with field and optional bucket, timezone, and alias. For example: [‘priority’, {‘field’: ‘created_at’, ‘bucket’: ‘day’}]. An alias names the field in the result; it defaults to the field name. Output names must be unique and at most 63 UTF-8 bytes.Fields you can group by:- Built-in fields:
status,priority,severity, andassignee_id(a user UUID). - Custom fields:
fields.region, replacingregionwith a defined field name. URL fields use the URL, not the display label. LONG_TEXT fields work as text. Other JSONB fields and MULTI_SELECT fields are unsupported. - Dates and times:
created_at,updated_at, and custom date/time fields. These require abucket:hour,day,week, ormonth. Weeks start on Monday.
- Timestamps accept an IANA timezone name, such as
America/New_York. The default isUTC; results always contain UTC timestamps. - DATE fields return
YYYY-MM-DD. They do not accept a timezone, and even anhourbucket retains only date precision.
- Missing values share one
nullgroup, including cases with no saved custom fields. - TEXT and SELECT values use only the first 256 characters. Values with the same prefix merge into one group.
- NUMERIC values appear as exact decimal strings.
- Use
dropdowns.categoryto group by option reference; replacecategorywith your dropdown reference. This requires case add-ons. Missing or deleted options share thenullgroup. - Use
tagsto group by tag reference. A case belongs to every tag group that applies to it; untagged cases share thenullgroup. Adding the group counts can therefore count a case more than once.
Choose what to calculate for each group. Omit this input to count cases. Supply up to 8 calculations; an empty list is invalid.Each calculation is an object with
function, optional field, and optional alias. For example: [{‘function’: ‘sum’, ‘field’: ‘fields.amount’, ‘alias’: ‘total’}].Available calculations:count: Count cases when you omitfield, or count non-null values when you supply it.count_distinct: Count different non-null values.sum,mean,median: Calculate the total, average, or middle value.min,max: Return the smallest or largest value.
count requires a field. Numeric custom fields support all functions. Text and date/time fields support count, count_distinct, min, and max. BOOLEAN and SELECT fields support only count and count_distinct.Naming and number formats:- Use
aliasto name a result, such astotal. Otherwise the name iscountorfunction_field, using the final part of the field name. All output names must be unique and at most 63 UTF-8 bytes. - Counts are integers. INTEGER/NUMERIC sums, all means and medians, and NUMERIC min/max use floating-point numbers and can lose precision. NUMERIC grouping values remain exact decimal strings.
min_count count each case once within each group. You cannot use sum, mean, or median with tag grouping.Default: null.Choose which cases to include before grouping. Omit this input to include all cases.Write one condition as {field, op, value}. For example: {‘field’: ‘status’, ‘op’: ‘in’, ‘value’: [‘new’, ‘in_progress’]}. Combine conditions with {‘and’: […]}, {‘or’: […]}, or {‘not’: {…}}.Choose an operator supported by the field type:
- Equality:
eq(equals),ne(does not equal). - Lists:
in(matches any listed value),not_in(matches none). Supply a list asvalue. - Ranges:
gt,gte,lt,lte(greater than, at least, less than, at most). - Text:
contains,starts_with. Both ignore case and match literal text. - Missing values:
is_null. Omitvalue; custom fields also match cases with no saved field row.
summary, description, and case_number. You cannot filter on short_id or payload. Use strings for exact decimals and ISO-formatted dates or timestamps.Built-in values must be lowercase:- Status:
unknown,new,in_progress,on_hold,resolved,closed,other. Status does not support range comparisons. - Priority, from lowest to highest:
low,medium,high,critical. - Severity, from lowest to highest:
informational,low,medium,high,critical,fatal. - Priority and severity also accept
unknownandotherfor equality or list matching. These values never match a range and cannot be range boundaries.
neandnot_inexclude missing values. An emptynot_inlist matches all cases; an emptyinlist matches none.- Where tag aggregation is supported,
tagsacceptscontains(one tag reference),in(any listed reference), oris_null(untagged). - Filters allow up to 4 levels of nesting, 50 conditions, and 1000 total values. The server validates the request when the action runs.
null.Set the maximum number of groups to return. Use at least 1, up to your server’s configured maximum (normally 1000). Omit this input to use the server default (normally 100).If more groups exist, the result sets
truncated to true. There is no next-page cursor.Default: null.Choose a group or calculation output name to sort by, including any alias you set.If omitted, results sort by the first date/time bucket, or by the first calculation when there is no date/time bucket.Default:
null.Use
asc for ascending order or desc for descending order.If omitted, the direction is asc when the action automatically sorts by a date/time bucket. Otherwise it is desc, including when you set order_by yourself. Missing values sort last; group values break ties.Default: null.Examples
Count open cases by priority and daycore.cases.list_case_events
List all events for a case in chronological order.
Inputs
Examples
List case eventscore.cases.assign_user
Assign a user to an existing case.
Inputs
Examples
Assign a user by IDcore.cases.assign_user_by_email
Assign a user to an existing case by email.
Inputs
Examples
Assign a user by emailcore.cases.add_case_tag
Add a tag to a case by tag ID or ref.
Inputs
Examples
Add a case tagcore.cases.remove_case_tag
Remove a tag from a case by tag ID or ref.
Inputs
Examples
Remove a case tagcore.cases.delete_case_tag
Delete a case tag from the workspace by tag ID or ref. This also removes the tag from every case.
Inputs
Examples
Delete a case tagcore.cases.delete_case
Delete a case.
Inputs
Examples
Delete a casecore.cases.add_sub_cases
Group cases as sub-cases of a top-level parent case, e.g. to collect duplicates under one primary case. Returns a result for each case.
Enterprise Edition
The result has one item per case with success and error, plus
succeeded and failed counts. A case that fails does not stop the others.
An invalid ID, or a short ID that matches no case, fails the whole request before any case changes.
If case_ids includes the parent case, that one item fails with
“A case cannot be its own parent” and the other cases are still grouped.
Inputs
IDs or short IDs of the cases to group under the parent (max 1000). An empty list does nothing. Cases under another parent are moved. Cases with their own sub-cases fail and are reported in the results.
The ID or short ID (e.g. CASE-0042) of the parent case. It must not be a sub-case itself.
Examples
Group duplicate cases under a primary casecore.cases.remove_sub_cases
Remove cases from their parent case, returning them to the top level. Returns a result for each case.
Enterprise Edition
The result has one item per case with success and error, plus
succeeded and failed counts. A case that fails does not stop the others.
An invalid ID, or a short ID that matches no case, fails the whole request before any case changes.
Inputs
IDs or short IDs of the sub-cases to remove from their parent (max 1000). An empty list does nothing.