Investigator API
GET Saved Search Folder By FolderId
Overview
Retrieves a specific saved search folder for a user.
OperationId: GET Saved Search Folder By FolderId
Authorization Method(s): OAuth
Verb: GET
End Point: /api/configuration/user/savedsearch/folder/{folderId}
Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.
| Display String | Field Name | Field Type |
|---|---|---|
| User Name | userName | string |
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Folder Id* | folderId | integer |
| Get Searches | getSearches | boolean |
| Get Children | getChildren | boolean |
| Api-version* | api-version | undefined |
Overview
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 204 | No Content |