Shorter Loop API Documentation
API References
Release NotesHelp CenterKnowledge Base
API References
Release NotesHelp CenterKnowledge Base
Sign In
  1. Idea manager
  • Getting started
    • Welcome to the Shorter Loop API Portal
    • Authentication
    • Base URL
    • 2 way Jira Integration
    • Create Incoming Webhooks in Shorter Loop
    • Create an Outgoing 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 experiment 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
  • Schemas
    • kpi_revisions
    • kpis
  1. Idea manager

Segments

Retrieves a list of segments without users
GET/api/v2/segments
Create segment
POST/api/v2/segments
Modify a segment
PUT/api/v2/segments/20
Removes a segment
DELETE/api/v2/segments/20
Bulk create users to a segment
POST/api/v2/segments/18/create-users
Bulk Create Users in Segment Endpoint POST /api/v2/segments/:segmentId/create-users Description Bulk creates new users associated with a specific segm...
Manage user segments: move or remove
PUT/api/v2/segments/19/segment-users/15
Endpoint /:id/manage-users/:toSegmentId? This endpoint is responsible for managing user assignments within segments. It handles two distinct operation...
Retrieve segments with users
GET/api/v2/segments/with-users
Endpoint GET /api/v2/segments/with-users Description Retrieves all segment options, including associated users and an optional count of users in each ...
Retrieve segment with users
GET/api/v2/segments/with-users/18
Endpoint GET /api/v2/segments/with-users/:segmentId Description Retrieves details of a specific segment option by segmentId, including the associated ...
Import Users (CSV/JSON)
POST/api/v2/segments/18/create-users
Endpoint POST /api/v2/segments/:segmentId/create-users Description Creates new users associated with a specific segment identified by segmentId. This ...
Sending email to segment members
POST/api/v2/segments/19/email
Sending email to selected idm members
POST/api/v2/segments/email
Previous
Bulk create feedback items: CSV and JSON
Next
Retrieves a list of segments without users
Built with