Shorter Loop API Documentation
  1. Teams
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
      • Modify a user story
      • Retrieve user story
      • Removes the user story
    • 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
        GET
    • 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. Teams

Get teams and members for product

GET
/api/user/teams/SHO-MJXR

Retrieve teams and their members associated with the product identified by the external key SHO-MJXR.

Notes:

  • Ensure the externalKey parameter (SHO-MJXR) corresponds to a valid product or initiative identifier.
  • Authentication token (Bearer ) must be included in the request headers for authorization.

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
subscriptionId
string 
required
How to get subscriptionId:
1- Visit https://app.shorterloop.com/ACME/product/SHO-MJXR/dashboard.
2- The subscriptionId is ACME in the URL.
3- Use this subscriptionId in the subscriptionId header for API requests.
Default:
CONOP
Example:
ACME
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/user/teams/SHO-MJXR' \
--header 'Authorization;' \
--header 'initiativeId;' \
--header 'subscriptionId;'

Responses

🟢200Success
application/json
Body
success
boolean 
required
data
array [object {11}] 
optional
id
integer 
optional
subscriptionId
integer 
optional
userId
integer 
optional
name
string 
optional
image
string 
optional
initiativeId
integer 
optional
status
string 
optional
createdAt
string 
optional
updatedAt
string 
optional
userTeamMapping
array [object {4}] 
optional
initiative
object 
optional
Example
{
  "success": false,
  "data": [
    {
      "id": 7,
      "subscriptionId": 18,
      "userId": 99,
      "name": "veniam qui quaerat",
      "image": "https://loremflickr.com/640/480/people",
      "initiativeId": 21,
      "status": "enim elit Lorem",
      "createdAt": "2024-07-11T04:37:21.485Z",
      "updatedAt": "2024-07-11T10:23:25.544Z",
      "userTeamMapping": [
        {
          "userId": 1,
          "userRole": "editor",
          "status": "cillum",
          "user": {
            "id": 70,
            "status": "active",
            "firstName": "Donavon",
            "lastName": "Mayert",
            "displayName": "blanditiis tempora exercitationem",
            "profileImage": "https://loremflickr.com/640/480/cats"
          }
        },
        {
          "userId": 59,
          "userRole": "editor",
          "status": "proident",
          "user": {
            "id": 33,
            "status": "inactive",
            "firstName": "Dejuan",
            "lastName": "Ernser",
            "displayName": "tenetur dolorem sint",
            "profileImage": "https://loremflickr.com/640/480/nature"
          }
        },
        {
          "userId": 62,
          "userRole": "superadmin",
          "status": "deserunt in mollit Ut exercitation",
          "user": {
            "id": 47,
            "status": "active",
            "firstName": "Arthur",
            "lastName": "Harber",
            "displayName": "suscipit id nulla",
            "profileImage": "https://loremflickr.com/640/480/nature"
          }
        }
      ],
      "initiative": {
        "id": 3,
        "initiativeName": "inventore unde repellendus"
      }
    },
    {
      "id": 14,
      "subscriptionId": 37,
      "userId": 72,
      "name": "eaque facere perferendis",
      "image": "https://loremflickr.com/640/480/nightlife",
      "initiativeId": 31,
      "status": "non dolore consequat",
      "createdAt": "2024-07-11T23:04:14.007Z",
      "updatedAt": "2024-07-11T05:35:14.184Z",
      "userTeamMapping": [
        {
          "userId": 74,
          "userRole": "editor",
          "status": "deserunt laboris in aute",
          "user": {
            "id": 13,
            "status": "active",
            "firstName": "Deontae",
            "lastName": "Runolfsdottir",
            "displayName": "pariatur amet esse",
            "profileImage": "https://loremflickr.com/640/480/city"
          }
        }
      ],
      "initiative": {
        "id": 16,
        "initiativeName": "autem doloremque porro"
      }
    }
  ]
}
Previous
Retrieves tags for initiative
Next
Retrieve personas associated with initiative
Built with