Shorter Loop API Documentation
  1. Personas
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
    • Personas
      • Retrieve personas associated with initiative
        GET
    • 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. Personas

Retrieve personas associated with initiative

Developing
GET
/api/users/initiative/SHO-MJXR/personas
Retrieve personas associated with the initiative identified by the external key SHO-MJXR.

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/users/initiative/SHO-MJXR/personas' \
--header 'Authorization;' \
--header 'initiativeId;'

Responses

🟢200Success
application/json
Body
success
boolean 
required
message
string 
optional
data
object 
required
personas
array [object {5}] 
required
Example
{
  "success": true,
  "message": "List of initiative personas",
  "data": {
    "personas": [
      {
        "id": 996,
        "personaName": "Product Managers (Strategy Oriented)",
        "image": "1346/1116/16802/PE-sCkV996cd5l.jpg",
        "externalKey": "PE-1",
        "profile": [
          {
            "label": "Name",
            "description": "Stewart"
          }
        ]
      },
      {
        "id": 997,
        "personaName": "Startup founders",
        "image": "1346/1116/16802/PE-zluf997mfeJ.jpg",
        "externalKey": "PE-2",
        "profile": [
          {
            "label": "Name",
            "description": "Fioana"
          }
        ]
      },
      {
        "id": 998,
        "personaName": "Product Owners (Execution Oriented)",
        "image": "1346/1116/16802/PE-SQnl998uVZL.jpg",
        "externalKey": "PE-3",
        "profile": [
          {
            "label": "Name",
            "description": "Emily"
          }
        ]
      },
      {
        "id": 999,
        "personaName": "UX Researchers",
        "image": "1346/1116/16802/PE-hXem999PqZx.jpg",
        "externalKey": "PE-4",
        "profile": [
          {
            "label": "Name",
            "description": "Uma"
          }
        ]
      },
      {
        "id": 1000,
        "personaName": "Engineers",
        "image": "1346/1116/16802/PE-B4iJ1000bGF7.jpg",
        "externalKey": "PE-5",
        "profile": [
          {
            "label": "Name",
            "description": "Eddy"
          }
        ]
      }
    ],
    "vision": {
      "visionStatement": "<p>An intuitive Product Management platform designed to empower teams, regardless of size or experience, to streamline continuous discovery, accelerate feedback cycles, and harness AI to enhance productivity and feature precision, thereby minimizing the risk of product failure.</p><figure class=\"image\"><img></figure>",
      "targetGroup": "",
      "needs": "<ul>\n<li>For Product Managers (Strategy Oriented): Tools for strategic planning and roadmapping, integration with analytics to inform decision-making, and AI-driven insights for market trends and product opportunities.</li>\n<li>For Startup founders: Affordable access to advanced product management features, scalability to grow with the company, and guidance on best practices for product development and launch.</li>\n<li>For Product Owners (Execution Oriented): Agile workflow management, prioritization features to manage backlogs efficiently, and real-time collaboration tools to align with cross-functional teams.</li>\n<li>For UX Researchers: Features for managing user testing and research, integrating user feedback into the product development process, and tools for tracking user experience metrics over time.</li>\n<li>For Engineers: Seamless integration with development tools, automated workflows to reduce manual tasks, and clear feature specifications to improve implementation accuracy.</li>\n</ul>",
      "product": "AI-driven platform for efficient product lifecycle management and precision.",
      "businessGoals": "<ul><li>Achieve 2% market share within the Product Management software industry by the end of year two.</li><li>Attain a user base of 200 active monthly users, with at least 60% consisting of the target user groups, within the first year of launch.</li><li>Secure a customer satisfaction score of 90% or above by continuously integrating user feedback to improve the platform.</li><li>Increase the average productivity of product teams by 30% within six months of platform adoption, as measured by feature delivery rate and cycle time.</li><li>Develop and deploy three AI-driven features that reduce time-to-market by at least 20% within the first 18 months post-launch.</li></ul>"
    }
  }
}
Previous
Get teams and members for product
Next
Get whole backlog tree
Built with