Shorter Loop API Documentation
API ReferencesRelease NotesHelp CenterKnowledge Base
API ReferencesRelease NotesHelp CenterKnowledge Base
Sign In
  1. Persona Board V2
  • 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 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
      POST
    • Retrieve notes
      GET
    • Retrieve persona
      GET
    • Retrieve experiments for Persona
      GET
    • Create
      POST
    • Retrieve
      GET
  • DocsHub
    • Retrieve categories with templates
    • Retrieve a template based on category
    • Create copy of template while using template
  1. Persona Board V2

Retrieve

GET
http://localhost:3000/api/v2/value-propositions/VP-1

Request

Header Params

Request Code 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 'http://localhost:3000/api/v2/value-propositions/VP-1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTM5OSwiZmlyc3ROYW1lIjoiRGluZXNoIiwibGFzdE5hbWUiOiJSYXdhdCIsInVzZXJFeHBlcmllbmNlIjpudWxsLCJlbWFpbCI6ImRyYXdhdEBzaG9ydGVybG9vcC5jb20iLCJkaXNwbGF5TmFtZSI6IkRpbmVzaCBSYXdhdCIsInByb2ZpbGVJbWFnZSI6Imh0dHBzOi8vbGgzLmdvb2dsZXVzZXJjb250ZW50LmNvbS9hL0FDZzhvY0pUdWdvbEpIal9HUEFielJIYU01akJCeEt1Tm5GZnBxekExMGpsYVRkd2NITW5kZz1zOTYtYyIsInRpbWVab25lQWJiciI6bnVsbCwic3RhdHVzIjoiYWN0aXZlIiwicHJvdmlkZXIiOiJnb29nbGUiLCJ0ZXJtc0FjY2VwdGVkIjoxLCJsYXN0UGFnZSI6Ii9TU1MvcHJvZHVjdC9EUkEvZGFzaGJvYXJkIiwidmVyaWZpY2F0aW9uVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKbGJXRnBiQ0k2SW1SeVlYZGhkRUJ6YUc5eWRHVnliRzl2Y0M1amIyMGlMQ0pwWkNJNk1UTTVPU3dpZEdsdFpTSTZJakl3TWpRdE1EWXRNamRVTURRNk1qTTZNREF1TURBNVdpSXNJblI1Y0dVaU9pSkpUbFpKVkVVaUxDSnpkV0p6WTNKcGNIUnBiMjVKWkNJNk1UQTJNeXdpZEdWaGJVbGtJam9pTXpnNUlpd2lhV0YwSWpveE56RTVORFl5TVRnd0xDSmxlSEFpT2pFM01qY3lNemd4T0RCOS5nSVpyNzVfV1BtLXNZbE1zamdpUGo1S3ZQNlZiZEwxUEVKQ05OWlFyLWxjIiwibGFzdFNpZ25JbiI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInJvbGUiOiJzdXBlcmFkbWluIiwiaXNQcm9kZWFzeUFkbWluIjowLCJncm91cCI6MSwicmVmZXJyZXIiOm51bGwsImlzVmVyaWZpZWQiOjEsInJlZmVycmVyVG9rZW4iOm51bGwsInJlZnJlc2hSZWZlcnJlclRva2VuIjpudWxsLCJiaW8iOm51bGwsImNyZWF0ZWRBdCI6IjIwMjMtMTItMTdUMDE6NDk6NDMuMDAwWiIsInVwZGF0ZWRBdCI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInN1YnNjcmlwdGlvbiI6eyJ1c2VyUm9sZSI6InN1cGVyYWRtaW4iLCJzdWJzY3JpcHRpb25FeHRlcm5hbEtleSI6IlNTUyIsImV4dGVybmFsS2V5IjoiU1NTIiwiY25hbWUiOm51bGwsImlkIjoxMDYzfSwic3Vic2NyaXB0aW9uSWQiOjEwNjMsImV4dGVybmFsS2V5IjoiU1NTIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJTU1MiLCJ0aW1lIjoiMjAyNC0wOC0xMFQwNDo0OTozOC45NTVaIiwiaWF0IjoxNzIzMjY1Mzc4LCJleHAiOjE3MzEwNDEzNzh9.5NP6xMoEi0z0yADIGoE99PcoSfAmoPq_qgWos4fQMR8' \
--header 'Authorization;' \
--header 'initiativeId: DRA' \
--header 'initiativeId;' \
--header 'subscriptionId: SSS'

Responses

🟢200OK
application/json
Body

Example
{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "externalKey": "string",
        "valuePropositionName": "string",
        "commentCount": 0,
        "totalExperiments": 0,
        "persona": {
            "id": 0,
            "image": null,
            "initiative": {
                "uniqueKey": null
            },
            "persona_elements": [
                {
                    "id": 0,
                    "label": "string",
                    "description": "string"
                }
            ]
        },
        "cards": [
            {
                "id": 0,
                "cardElementKey": "string",
                "description": "string",
                "order": 0,
                "color": null,
                "favourite": true,
                "totalExperiment": 0,
                "provenExperiment": 0,
                "personaId": null,
                "importance": null,
                "uncertainty": null,
                "opportunity": {
                    "id": 0,
                    "description": "string",
                    "externalKey": "string",
                    "userId": "string",
                    "color": "string",
                    "urls": "string",
                    "spread": "string",
                    "intensity": "string",
                    "progress": "string"
                }
            }
        ],
        "assets": null
    }
}
Modified at 2024-09-03 07:31:08
Previous
Create
Next
Retrieve categories with templates
Built with