# Shorter Loop API Documentation ## Docs - Getting started [Welcome to the Shorter Loop API Portal](https://developer.shorterloop.com/doc-588338.md): - Getting started [Authentication](https://developer.shorterloop.com/doc-588376.md): - Getting started [Base URL](https://developer.shorterloop.com/doc-588405.md): - Strategy Board > Solutions > Versions [Storymap versions api documentation](https://developer.shorterloop.com/doc-665389.md): ## API Docs - Metrics [Create a Key Performance Indicator (KPI)](https://developer.shorterloop.com/api-8559504.md): Create a Key Performance Indicator (KPI) for the initiative identified by the external key SHO-MJXR. - Metrics [Update the Key Performance Indicator (KPI)](https://developer.shorterloop.com/api-8559656.md): Update the Key Performance Indicator (KPI) identified by ID 7564 under the initiative with external key SHO-MJXR. - Metrics [Retrieve KPIs not linked to specific product backlog items](https://developer.shorterloop.com/api-8559761.md): Retrieve all Key Performance Indicators (KPIs) associated with the initiative identified by the external key SHO-MJXR, which are not linked to any specific product backlog work item. - Metrics [Insert KPI's records (Body JSON Payload)](https://developer.shorterloop.com/api-7276938.md): This API endpoint allows users to insert Key Performance Indicators (KPIs) by providing JSON data directly in the request body. This request supports only the insertion of new KPI records based on the provided JSON in the body payload. - Metrics [Insert KPI's records (Upload CSV)](https://developer.shorterloop.com/api-7475193.md): This API endpoint allows users to insert Key Performance Indicators (KPIs) by uploading a CSV file. This request supports only the insertion of new KPI records via the CSV file upload. - Metrics [Insert KPI's records (Upload JSON)](https://developer.shorterloop.com/api-7475280.md): This API endpoint allows users to insert Key Performance Indicators (KPIs) by uploading a JSON file. This request supports only the insertion of new KPI records through JSON file upload. - Idea manager > Feedback Collection [Create idea and issue](https://developer.shorterloop.com/api-8543537.md): This endpoint is used to create a new feedback item in the IDM. - Idea manager > Feedback Collection [Retrieves a list of categories](https://developer.shorterloop.com/api-8543886.md): - Idea manager > Feedback Collection [Modify feedback item](https://developer.shorterloop.com/api-8544028.md): The PATCH /api/feedback-items/IDEA-21 endpoint is used to partially update an existing feedback item identified by the external key IDEA-21. This endpoint allows users to modify specific details of a feedback item without altering the entire record. - Idea manager > Feedback Collection [Removes a feedback item](https://developer.shorterloop.com/api-8544575.md): The DELETE /api/feedback-items/{externalKey} endpoint is used to delete an existing feedback item identified by the specified external key. This endpoint allows users to remove feedback items from the system, ensuring that irrelevant or outdated feedback can be efficiently managed. - Idea manager > Feedback Collection [Upvote or downvote a work item](https://developer.shorterloop.com/api-8545273.md): The POST /api/votes/IDEA-21 endpoint allows users to upvote or downvote a work item identified by the external key IDEA-21. This functionality is typically used to indicate user preference or feedback on the importance or quality of a particular work item. It toggles the vote. - Idea manager > Feedback Collection [Retrieve a feedback item](https://developer.shorterloop.com/api-8545525.md): - Idea manager > Feedback Collection [Get comments for a feedback item.](https://developer.shorterloop.com/api-8545532.md): - Idea manager > Feedback Collection [Reply to a comment](https://developer.shorterloop.com/api-8545533.md): - Idea manager > Feedback Collection [Modify a comment](https://developer.shorterloop.com/api-8545997.md): - Idea manager > Feedback Collection [Bulk create feedback items: CSV and JSON](https://developer.shorterloop.com/api-11078410.md): - Idea manager > Segments [Retrieves a list of segments without users](https://developer.shorterloop.com/api-11032095.md): - Idea manager > Segments [Create segment](https://developer.shorterloop.com/api-11045824.md): - Idea manager > Segments [Modify a segment](https://developer.shorterloop.com/api-11046080.md): - Idea manager > Segments [Removes a segment](https://developer.shorterloop.com/api-11046641.md): - Idea manager > Segments [Bulk create users to a segment](https://developer.shorterloop.com/api-11051255.md): ## Bulk Create Users in Segment - Idea manager > Segments [Manage user segments: move or remove](https://developer.shorterloop.com/api-11054785.md): ## Endpoint - Idea manager > Segments [Retrieve segments with users](https://developer.shorterloop.com/api-11068848.md): ### Endpoint - Idea manager > Segments [Retrieve segment with users](https://developer.shorterloop.com/api-11141784.md): ### Endpoint - Idea manager > Segments [Import Users (CSV/JSON)](https://developer.shorterloop.com/api-11143261.md): ### Endpoint - Idea manager > Segments [Sending email to segment members](https://developer.shorterloop.com/api-11176322.md): - Idea manager > Segments [Sending email to selected idm members](https://developer.shorterloop.com/api-11408608.md): - Idea manager [Bulk create idea manager members](https://developer.shorterloop.com/api-11141953.md): ## Bulk Create Users in Segment or Idea Manager - Idea manager [Import Users (CSV/JSON) in IDM](https://developer.shorterloop.com/api-11143525.md): ## Bulk Create Users in Idea Manager with CSV/JSON Upload - Idea manager [Bulk re-invite in IDM](https://developer.shorterloop.com/api-11159098.md): - Backlog Management > Epics [Create a new epic](https://developer.shorterloop.com/api-8545819.md): The POST /api/initiatives/SHO-MJXR/epics endpoint creates a new epic under the initiative identified by the external key SHO-MJXR. Epics are large bodies of work that can be broken down into smaller, manageable features or user stories. - Backlog Management > Epics [Modify an epic](https://developer.shorterloop.com/api-8545983.md): The POST /api/initiatives/SHO-MJXR/epics endpoint creates a new epic under the initiative identified by the external key SHO-MJXR. Epics are large bodies of work that can be broken down into smaller, manageable features or user stories. - Backlog Management > Epics [Retrieve details of the epic](https://developer.shorterloop.com/api-8555772.md): The GET /api/initiatives/SHO-MJXR/epics/EP-41 endpoint retrieves detailed information about the epic identified by EP-41 within the initiative identified by SHO-MJXR. - Backlog Management > Epics [Removes the epic](https://developer.shorterloop.com/api-8557585.md): Delete the epic identified by ID 1088 under the initiative identified by the external key SHO-MJXR. - Backlog Management > Features [Create a new feature](https://developer.shorterloop.com/api-8560059.md): The POST /api/initiatives/SHO-MJXR/features endpoint creates a new feature under the initiative identified by the external key SHO-MJXR. - Backlog Management > Features [Modify a feature](https://developer.shorterloop.com/api-8560117.md): The POST /api/initiatives/SHO-MJXR/epics endpoint creates a new feature under the initiative identified by the external key SHO-MJXR. - Backlog Management > Features [Retrieve details of the feature](https://developer.shorterloop.com/api-8560361.md): The GET /api/initiatives/SHO-MJXR/features/FE-75 endpoint retrieves detailed information about the feature identified by FE-75 within the initiative identified by SHO-MJXR. - Backlog Management > Features [Removes the feature](https://developer.shorterloop.com/api-8560376.md): Delete the feature identified by ID 1098 under the initiative identified by the external key SHO-MJXR. - Backlog Management > User stories [Create a new user story](https://developer.shorterloop.com/api-8560379.md): The POST /api/initiatives/SHO-MJXR/storyMap/card endpoint creates a new user story under the initiative identified by the external key SHO-MJXR. - Backlog Management > User stories [Modify a user story](https://developer.shorterloop.com/api-8560380.md): Update the details of the card identified by ID 1238 in the story map of the initiative with external key SHO-MJXR. - Backlog Management > User stories [Retrieve user story](https://developer.shorterloop.com/api-8560381.md): Retrieve details of the user story identified by US-19 from the initiative with external key SHO-MJXR. - Backlog Management > User stories [Removes the user story](https://developer.shorterloop.com/api-8560382.md): Delete the usersory identified by ID 1238 under the initiative identified by the external key SHO-MJXR. - Backlog Management > Assets [Attaches files to the workitem](https://developer.shorterloop.com/api-8545862.md): The POST /api/assets endpoint attaches files to the epic identified by the unique identifier EPIC-123456. This functionality allows users to upload relevant documents, images, or other files that provide additional context or resources related to the epic - Backlog Management > Assets [Removes an asset](https://developer.shorterloop.com/api-8546398.md): - Backlog Management > Assets [Retrieve attachments for the backlog workitem with ID](https://developer.shorterloop.com/api-8555559.md): The GET /api/assets?artifactId=1087&usedAt=epic endpoint retrieves all attachments associated with the epic identified by the ID 1087. - Backlog Management > Product Tags [Retrieves tags for initiative](https://developer.shorterloop.com/api-8555616.md): - Backlog Management > Teams [Get teams and members for product](https://developer.shorterloop.com/api-8557283.md): Retrieve teams and their members associated with the product identified by the external key SHO-MJXR. - Backlog Management > Personas [Retrieve personas associated with initiative](https://developer.shorterloop.com/api-8557417.md): Retrieve personas associated with the initiative identified by the external key SHO-MJXR. - Backlog Management [Get whole backlog tree](https://developer.shorterloop.com/api-9858373.md): Replace PRO-ID with yours in the parameter - Strategy Board > Experiment [Create a new experiemnt variant](https://developer.shorterloop.com/api-8766081.md): - Strategy Board > Solutions > Versions [Create a version](https://developer.shorterloop.com/api-10112173.md): - Strategy Board > Solutions > Versions [Update version](https://developer.shorterloop.com/api-10112687.md): - Strategy Board > Solutions > Versions [Removes a version](https://developer.shorterloop.com/api-10113757.md): - Strategy Board > Solutions > Versions [Retrieve versions](https://developer.shorterloop.com/api-10122837.md): - Strategy Board > Solutions [Get all storymaps for solution](https://developer.shorterloop.com/api-10010793.md): - Persona Board V2 > Segments [Permanently deletes a segment](https://developer.shorterloop.com/api-9692599.md): Permanently deletes a segment, its options, and its mappings. - Persona Board V2 > Segments [Creates a new option](https://developer.shorterloop.com/api-9692598.md): Adds new options to an existing segment. - Persona Board V2 > Segments [Retrieve a list of segments](https://developer.shorterloop.com/api-9692591.md): - Persona Board V2 > Segments [Retrieve a segment](https://developer.shorterloop.com/api-9692592.md): - Persona Board V2 > Segments [Create a segment](https://developer.shorterloop.com/api-9692593.md): - Persona Board V2 > Segments [Removes a segment](https://developer.shorterloop.com/api-9692594.md): - Persona Board V2 > Segments [Removes a segment option](https://developer.shorterloop.com/api-9692595.md): - Persona Board V2 > Segments [Detaches a segment from the persona](https://developer.shorterloop.com/api-9692596.md): - Persona Board V2 > Segments [Update segment option](https://developer.shorterloop.com/api-9692611.md): - Persona Board V2 > Custom fields [Removes a custom field](https://developer.shorterloop.com/api-9692603.md): - Persona Board V2 > Custom fields [Retrieve a list of custom fields](https://developer.shorterloop.com/api-9692600.md): - Persona Board V2 > Custom fields [Retrieve a custom field](https://developer.shorterloop.com/api-9692601.md): - Persona Board V2 > Custom fields [Create a custom field](https://developer.shorterloop.com/api-9692602.md): - Persona Board V2 > Custom fields [Removes a custom field option](https://developer.shorterloop.com/api-9692604.md): - Persona Board V2 > Custom fields [Detaches a custom field from persona](https://developer.shorterloop.com/api-9692605.md): - Persona Board V2 > Custom fields [Retrieve custom fields excluding persona](https://developer.shorterloop.com/api-9692606.md): Retrieves all segments where the personaId is not the specified personaId. - Persona Board V2 > Custom fields [Creates a new option](https://developer.shorterloop.com/api-9692607.md): Adds new options to an existing custom field. - Persona Board V2 > Custom fields [Permanently deletes a custom field](https://developer.shorterloop.com/api-9692608.md): Permanently deletes a segment, its options, and its mappings. - Persona Board V2 > Custom fields [Update custom field](https://developer.shorterloop.com/api-9692609.md): - Persona Board V2 > Custom fields [Update custom field option](https://developer.shorterloop.com/api-9692610.md): - Persona Board V2 > Custom fields [Attach a custom field to a persona](https://developer.shorterloop.com/api-10013172.md): - Persona Board V2 [Create opportunities from summary](https://developer.shorterloop.com/api-9692614.md): - Persona Board V2 [Retrieve notes](https://developer.shorterloop.com/api-9692615.md): - Persona Board V2 [Retrieve persona](https://developer.shorterloop.com/api-9692617.md): APP-DAX2 is your initiativeId - Persona Board V2 [Retrieve experiments for Persona](https://developer.shorterloop.com/api-9692616.md): - Persona Board V2 [Create](https://developer.shorterloop.com/api-9692612.md): - Persona Board V2 [Retrieve](https://developer.shorterloop.com/api-9692613.md): - DocsHub [Retrieve categories with templates](https://developer.shorterloop.com/api-15463410.md): - DocsHub [Retrieve a template based on category](https://developer.shorterloop.com/api-15501552.md): - DocsHub [Create copy of template while using template](https://developer.shorterloop.com/api-15501856.md): - [testing](https://developer.shorterloop.com/api-15891424.md):