Shorter Loop API Documentation
  1. User stories
Shorter Loop API Documentation
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create webhook in Shorter Loop
  • Metrics
    • Create a Key Performance Indicator (KPI)
      POST
    • Update the Key Performance Indicator (KPI)
      PUT
    • Retrieve KPIs not linked to specific product backlog items
      GET
    • Insert KPI's records (Body JSON Payload)
      POST
    • Insert KPI's records (Upload CSV)
      POST
    • Insert KPI's records (Upload JSON)
      POST
  • Idea manager
    • Feedback Collection
      • Create idea and issue
      • Retrieves a list of categories
      • Modify feedback item
      • Removes a feedback item
      • Upvote or downvote a work item
      • Retrieve a feedback item
      • Get comments for a feedback item.
      • Reply to a comment
      • Modify a comment
      • Bulk create feedback items: CSV and JSON
    • Segments
      • Retrieves a list of segments without users
      • Create segment
      • Modify a segment
      • Removes a segment
      • Bulk create users to a segment
      • Manage user segments: move or remove
      • Retrieve segments with users
      • Retrieve segment with users
      • Import Users (CSV/JSON)
      • Sending email to segment members
      • Sending email to selected idm members
    • Bulk create idea manager members
      POST
    • Import Users (CSV/JSON) in IDM
      POST
    • Bulk re-invite in IDM
      PUT
  • Backlog Management
    • Epics
      • Create a new epic
      • Modify an epic
      • Retrieve details of the epic
      • Removes the epic
    • Features
      • Create a new feature
      • Modify a feature
      • Retrieve details of the feature
      • Removes the feature
    • User stories
      • Create a new user story
        POST
      • Modify a user story
        PUT
      • Retrieve user story
        GET
      • Removes the user story
        DELETE
    • Assets
      • Attaches files to the workitem
      • Removes an asset
      • Retrieve attachments for the backlog workitem with ID
    • Product Tags
      • Retrieves tags for initiative
    • Teams
      • Get teams and members for product
    • Personas
      • Retrieve personas associated with initiative
    • Get whole backlog tree
      GET
  • Strategy Board
    • Experiment
      • Create a new experiemnt variant
    • Solutions
      • Versions
        • Storymap versions api documentation
        • Create a version
        • Update version
        • Removes a version
        • Retrieve versions
      • Get all storymaps for solution
  • Persona Board V2
    • Segments
      • Permanently deletes a segment
      • Creates a new option
      • Retrieve a list of segments
      • Retrieve a segment
      • Create a segment
      • Removes a segment
      • Removes a segment option
      • Detaches a segment from the persona
      • Update segment option
    • Custom fields
      • Removes a custom field
      • Retrieve a list of custom fields
      • Retrieve a custom field
      • Create a custom field
      • Removes a custom field option
      • Detaches a custom field from persona
      • Retrieve custom fields excluding persona
      • Creates a new option
      • Permanently deletes a custom field
      • Update custom field
      • Update custom field option
      • Attach a custom field to a persona
    • Create opportunities from summary
    • Retrieve notes
    • Retrieve persona
    • Retrieve experiments for Persona
    • Create
    • Retrieve
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  • testing
    GET
  1. User stories

Retrieve user story

GET
/api/initiatives/SHO-MJXR/user-story/US-19
Retrieve details of the user story identified by US-19 from the initiative with external key SHO-MJXR.
Notes:
Ensure that a valid authentication token is provided in the request headers.
Ensure that you provide right userstory external key

Request

Header Params
Authorization
string 
required
Default:
Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc
initiativeId
string 
required
How to get initiativeId:
Visit https://app.shorterloop.com/ACME/product/SHO-MJXR/dashboard.
The initiativeId is SHO-MJXR in the URL.
Use this initiativeId in the initiativeId header for API requests.
Default:
DEE
Example:
MGMT
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/user-story/US-19' \
--header 'Authorization;' \
--header 'initiativeId;'

Responses

🟢200Success
application/json
Body
userStory
object 
optional
id
integer 
required
summary
string 
required
description
string 
optional
order
integer 
optional
externalKey
string 
required
color
string 
optional
initiativeId
string 
optional
backlog
boolean 
optional
progress
string 
optional
tags
string 
optional
timeBoxPlanningId
integer 
optional
businessObjectiveId
integer 
optional
businessGoal
string 
optional
dueDate
null 
optional
remainingTime
string 
optional
storyPoint
integer 
optional
featureId
integer 
optional
Provide it if you want to make feature the parent
persona
array [object {2}] 
optional
epicId
integer 
optional
Provide it if you want to make epic the parent
teamId
null 
optional
urls
string 
optional
userId
array[integer]
optional
startDate
string 
optional
endDate
string 
optional
externalProgress
string 
optional
kpis
array[string]
optional
owner
object 
optional
id
integer 
optional
email
string 
optional
firstName
string 
optional
lastName
string 
optional
displayName
string 
optional
timeZoneAbbr
null 
optional
profileImage
string 
optional
provider
string 
optional
role
string 
optional
group
boolean 
optional
bio
null 
optional
Example
{
  "userStory": {
    "id": -15239386,
    "summary": "officia Excepteur laboris fugiat",
    "description": "At eveniet tenetur est. Ex eius suscipit dolore iusto expedita illo. Reiciendis amet quaerat earum aut ratione expedita.",
    "order": -53012668,
    "externalKey": "ut eiusmod aliquip",
    "color": "plum",
    "initiativeId": "voluptate ullamco exercitation sed minim",
    "backlog": true,
    "progress": "aliquip in nulla pariatur do",
    "tags": "a",
    "timeBoxPlanningId": 32376076,
    "businessObjectiveId": 33284982,
    "businessGoal": "labore ea",
    "dueDate": null,
    "remainingTime": "2024-07-11T05:00:08.851Z",
    "storyPoint": -40723231,
    "featureId": -11518767,
    "persona": [
      {
        "personaValue": "eu Ut nostrud aliquip",
        "personaId": -4585867
      },
      {
        "personaValue": "aute adipisicing laboris id pariatur",
        "personaId": 59111262
      }
    ],
    "epicId": -12222018,
    "teamId": null,
    "urls": "reprehenderit non incididunt aliqua",
    "userId": [
      62098406
    ],
    "startDate": "2024-07-11T22:57:25.887Z",
    "endDate": "2024-07-11T19:12:59.640Z",
    "externalProgress": "deserunt elit aliqua cillum",
    "kpis": [
      "quis commodo enim",
      "ut sint pariatur labore nisi",
      "esse ut Ut eu cupidatat"
    ]
  },
  "owner": {
    "id": 74812996,
    "email": "Damon.Hessel9@yahoo.com",
    "firstName": "Elenora",
    "lastName": "Gutkowski",
    "displayName": "sint ex modi",
    "timeZoneAbbr": null,
    "profileImage": "https://loremflickr.com/640/480/nature",
    "provider": "consectetur Ut sit aliqua",
    "role": "commodo enim voluptate occaecat",
    "group": true,
    "bio": null
  }
}
Previous
Modify a user story
Next
Removes the user story
Built with