POST /api/v2/autocomplete/tags
Returns an array of registered and recent tag names that start with the characters specified in the name parameter. This includes tags where any word within the tag (separated by underscores, hyphens, spaces, or other punctuation) starts with the specified characters. You must specify at least 2 characters.
This endpoint accepts the same parameters as the GET method but they are specified in the request body instead of the query string.
How tag matching works
When tags contain delimiters like underscores, hyphens, or spaces, each word is indexed separately. A tag matches if the tag itself or any word within it starts with your search term.
For example, searching for trig will match the tag set_by_this_trigger because one of its words ("trigger") starts with "trig". However, searching for rigger won't match this tag because neither the full tag nor any of its individual words ("set", "by", "this", "trigger") start with "rigger".
Autocomplete limitations
Autocomplete returns up to 15 suggestions from the most commonly used ticket tags in the last 60 days. Tags that match the prefix but aren't in that top set won't appear in the results.
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
A substring of a tag to search for |
per_page |
Integer | No |
Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | No |
A substring of a tag to search for |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.