Search
Search
Runs the global search behind the search box: tickets, knowledge base articles and list entries are searched in parallel and enriched with semantically similar records plus matching Users, groups and lists, where the ticket, article and similar-item sections are capped at ten rows each and the additional_ counts report how many more matched.
A blank query gives an empty result while anything shorter than three characters is rejected, a query shaped like #1234 is treated as a lookup of that record id, and the response carries a key plus gpt_applicable that say whether an AI answer is being produced in the background and under which key it can be collected.
GET
/api/{tenant:minlength(2)}/v{version:apiVersion}/search/search
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_search_response_wrapper
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 403 (Forbidden)
Response body example
| Name | Type | ReadOnly | Description |
|---|
| id_search | Int32 (nullable) | | Id search |
| debug_vector_match_threshold | Double | | Debug vector match threshold |
| debug_max_estimated_tokens | Int32 | | Debug max estimated tokens |
| debug_similarity_rejection_threshold | Double | | Debug similarity rejection threshold |
| sort_by_key | String | | Sort by key |
| response_field_keys | String[] | | Response field keys |
| filters | String[] | | Filters |
| include_aggregations | Boolean | | Include aggregations |
| include_imported | Boolean | | Include imported |
| search | String | | Search |
| sort_order | ENUM sort_order | | Sort order |
| take | Int32 | | Take |
| page | Int32 | | Page |
DTO_search_response_wrapper
DTO_search_response
| Name | Type | ReadOnly | Description |
|---|
| sys_status | DTO_reference | | Sys status |
| category | DTO_reference | | Category |
| group | DTO_reference | | Group |
| id | Int32 | | Id |
| title | String | | Title |
| highlight | String | | Highlight |
| additional_info | String | | Additional info |
| entity | ENUM entity | ReadOnly | Entity |
| score | Double | ReadOnly | Score |
| score_weighted | Double | ReadOnly | Score weighted |
| external_link | String | ReadOnly | External link |
| created | DateTime | | Created |
| body | String | | Store the full text of the entity in plain text. |
DTO_reference
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | The id of the reference |
| label | Object | ReadOnly | Name/Label from referenced object. |
DTO_search_debug_response
| Name | Type | ReadOnly | Description |
|---|
| took_explained | DTO_took[] | | Took explained |
| error_message | String | | Error message |
| chat_messages | String[] | | Chat messages |
| tokens_count_estimated | Int32 | | Tokens count estimated |
| key_phrases | String[] | | Key phrases |
| debug_messages | String[] | | Debug messages |
DTO_took
| Name | Type | ReadOnly | Description |
|---|
| item | String | | Item |
| took_ms | Int64 | | Took ms |
ENUM entity
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | LIST | LIST |
| 2 | GROUP | GROUP |
| 3 | USER | USER |
| 4 | LIST_ENTRY | LIST_ENTRY |
| 5 | TICKET | TICKET |
| 6 | SEARCH | SEARCH |
| 7 | INVOICE | INVOICE |
| 8 | KNOWLEDGE_BASE | KNOWLEDGE_BASE |
| 9 | SCRAPED_ITEM | SCRAPED_ITEM |
| 10 | FIELD | FIELD |
| 11 | TICKET_CONVERSATION | TICKET_CONVERSATION |
| 12 | EXPORT | EXPORT |
| 13 | EXTERNAL_PRODUCT | EXTERNAL_PRODUCT |
| 14 | TEMPLATE | TEMPLATE |
| 15 | PROFILE_API | PROFILE_API |
| 16 | FAQ | FAQ |
ENUM sort_order
| Value | Name | Description |
|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
ENUM search_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | INVALID | Invalid |
| 2 | NOT_APPLICABLE | Not applicable |
| 3 | IN_PROGRESS | In progress |
| 4 | COMPLETED | Completed |
| 5 | OTHER_SEARCH_IN_PROGRESS | Another search in progress |
| 6 | NO_DATA | No data |
| 7 | NO_ACTIVE_SEARCH | No active search |
| 8 | TIMED_OUT | Timed out |
Generated Aug 4, 2026 18:37
