External DocumentationTo learn more, visit the Halo ITSM documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Client ID | The ID of the client to filter ticket types by. |
| Group ID | The ID of the ticket type group to filter by. |
| ITIL Type | The ITIL type to filter ticket types by, as an integer code. |
| Show Inactive | Select to include inactive ticket types in the response. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Access Control Level | The access control level to filter ticket types by. |
| Can Agents Select | Select to return only the ticket types that agents can select. |
| Can Create Only | Select to return only the ticket types the connected agent can create. |
| Can Edit Only | Select to return only the ticket types the connected agent can edit. |
| Can User Create | Select to return only the ticket types that end users can create. |
| Domain | Select the area to count tickets in. |
| Include Current | The ID of a ticket type to always include in the response, used with Can Create Only and Can Edit Only. |
| Include Mandatory Field Check | Select to include the mandatory field check in the response. |
| Outcome ID | The ID of the outcome to filter ticket types by. Can be obtained from the List Outcomes action. |
| Quick Time Dropdown Only | Select to return only the ticket types shown in the quick time dropdown. |
| Search Tickets | The ticket search term to filter ticket types by. |
| Show All | Select to return all ticket types, overriding ticket permissions. Note: Requires an admin agent. |
| Show Counts | Select to include the number of tickets for each ticket type in the response. |
| Sprints Only | Select to return only the ticket types that use sprints. |
| Ticket Area ID | The ID of the ticket area to count tickets in. |
| User Only | Select to return only the ticket types that end users can see. |
| View ID | The ID of the ticket view to count tickets in. |
| Viewable By Anonymous Users | Select to return only the ticket types that anonymous users can view. |
Example Output
[
{
"id": 0,
"name": "string",
"ticket_count": 0,
"use": "string",
"sequence": 0
}
]