Specifies the ID or UUID of the agent group to query. You can retrieve the agent group ID or UUID by using the List agent groups endpoint.

Specifies a filter condition in the field:operator:value format. For example, field1:match:sometext matches any records where the value of field1 contains sometext. You can specify multiple f parameters.

Specifies whether an and or or condition is applied when multiple f parameters are present. If the filter type is and, a record is only returned if all filters match. If the filter type is or, a record is returned if any filter matches.

Specifies a wildcard filter string to match against multiple fields of a record simultaneously. If any supported wildcard_fields value matches the filter string, the record matches the wildcard filter. For a record to be returned, it must pass the wildcard filter (if present) AND all standard filters. For example, w=wild&f=field1:match:one&f=field2:match:two&ft=or returns records where any supported wildcard field contains wild, AND either field1 contains one or field2 contains two.

Specifies a comma-separated subset of wildcard_fields to search when applying the wildcard filter. For example, field1,field2. If w is provided but wf is omitted, the system searches all supported wildcard_fields against the wildcard filter text.

Specifies the field and order used to sort the results, in the format field:order. The order must be asc (ascending) or desc (descending). For example, name:desc sorts results by the name field in descending order.

To sort by multiple fields, separate each field:order pair with a comma. For example, name:desc,creation_date:asc sorts first by name descending, then by creation_date ascending.

Note: Sort can only be applied to sortable fields specified by the filter capabilities, and the number of sort columns cannot exceed the max_sort_fields value specified by the filter capabilities.

Generated from available response content types