Shortcuts API
The Shortcuts API enables you to create and manage search shortcuts that provide quick access to frequently used queries and resources. Build custom shortcuts that help users navigate to important content and perform common searches more efficiently.
Use Cases
Quick Access Links
Create shortcuts that instantly navigate users to frequently accessed documents, dashboards, and resources without complex searches.
Saved Searches
Enable users to save and quickly re-execute common search queries with predefined filters and parameters.
Workflow Optimization
Streamline user workflows by providing one-click access to routine searches and frequently needed information.
API Endpoints
Method | Endpoint | Purpose |
---|---|---|
POST | /rest/api/v1/createshortcut | Create shortcut Create a user-generated shortcut that contains an alias and destination URL. |
POST | /rest/api/v1/deleteshortcut | Delete shortcut Delete an existing user-generated shortcut. |
POST | /rest/api/v1/getshortcut | Read shortcut Read a particular shortcut's details given its ID. |
POST | /rest/api/v1/listshortcuts | List shortcuts List shortcuts editable/owned by the currently authenticated user. |
POST | /rest/api/v1/updateshortcut | Update shortcut Updates the shortcut with the given ID. |