Retrieve details of the epic

GET

/api/initiatives/SHO-MJXR/epics/EP-41

The GET /api/initiatives/SHO-MJXR/epics/EP-41 endpoint retrieves detailed information about the epic identified by EP-41 within the initiative identified by SHO-MJXR.

Notes:

Ensure that a valid authentication token is provided in the request headers.

Ensure that you provide right epic external key

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.shorterloop.com/api/initiatives/SHO-MJXR/epics/EP-41?externalKey=EP-41' \
--header 'x-api-key: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MjA3NSwiZmlyc3ROYW1lIjoiZGVlcGlrYSIsImxhc3ROYW1lIjpudWxsLCJ1c2VyRXhwZXJpZW5jZSI6bnVsbCwiZW1haWwiOiJkcGF0aWFsK2ppcmFAc2hvcnRlcmxvb3AuY29tIiwiZGlzcGxheU5hbWUiOiJkZWVwaWthIiwicHJvZmlsZUltYWdlIjoiMTM3OC9nZW5lcmFsL3VzZXJzL0lJM0YyMDc1YzZhNS5zdmciLCJ0aW1lWm9uZUFiYnIiOm51bGwsInN0YXR1cyI6ImFjdGl2ZSIsInByb3ZpZGVyIjoiY3VzdG9tIiwidGVybXNBY2NlcHRlZCI6MSwibGFzdFBhZ2UiOiIvQ09OT1AvcHJvZHVjdC9ERUUvZG9jdW1lbnRhdGlvbi91bnRpdGxlZC02LTY0ZjQiLCJ2ZXJpZmljYXRpb25Ub2tlbiI6IiIsImxhc3RTaWduSW4iOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJyb2xlIjoic3VwZXJhZG1pbiIsImlzUHJvZGVhc3lBZG1pbiI6MCwiZ3JvdXAiOjEsInJlZmVycmVyIjpudWxsLCJpc1ZlcmlmaWVkIjoxLCJyZWZlcnJlclRva2VuIjpudWxsLCJyZWZyZXNoUmVmZXJyZXJUb2tlbiI6bnVsbCwiYmlvIjpudWxsLCJjcmVhdGVkQXQiOiIyMDI1LTAzLTE3VDA5OjM2OjU2LjAwMFoiLCJ1cGRhdGVkQXQiOiIyMDI1LTA0LTAxVDE0OjMwOjIwLjAwMFoiLCJzdWJzY3JpcHRpb24iOnsidXNlclJvbGUiOiJzdXBlcmFkbWluIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJDT05PUCIsImV4dGVybmFsS2V5IjoiQ09OT1AiLCJjbmFtZSI6bnVsbCwiaWQiOjEzNzh9LCJzdWJzY3JpcHRpb25JZCI6MTM3OCwiZXh0ZXJuYWxLZXkiOiJDT05PUCIsInN1YnNjcmlwdGlvbkV4dGVybmFsS2V5IjoiQ09OT1AiLCJ0aW1lIjoiMjAyNS0wNC0wMlQwNTo0Mzo1NC41MDRaIiwiaWF0IjoxNzQzNTcyNjM0LCJleHAiOjE3NDM4MzE4MzR9.UJaUHpd_XJyGSv4C0DaaEVxDDQKzKZ_lKPkf8Yrr-Oc' \
--header 'Content-Type: application/json'

Response Example

{
    "success": true,
    "data": {
        "id": 1087,
        "summary": "Enhance User Engagement and Retention",
        "backlog": true,
        "description": "<p>Improve user engagement and retention metrics through targeted feature enhancements and optimizations across the platform.</p><p>&nbsp;</p>",
        "externalKey": "EP-41",
        "color": "#ffb64f",
        "estimate": "60",
        "score": "1.6666666666666667",
        "businessValue": "100",
        "order": 19,
        "progress": "review",
        "externalProgress": "",
        "jiraId": "",
        "jiraKey": "",
        "jiraSelf": null,
        "jiraParentId": "",
        "teamId": null,
        "businessGoal": "Increase Monthly Active Users (MAUs) by 20% within the next fiscal year.",
        "tags": "[\"Epic\",\"User engagement\"]",
        "urls": [
            {
                "url": "https://example.com"
            },
            {
                "url": "https://example.com"
            }
        ],
        "persona": "[{\"personaValue\":\"UX Researchers\",\"personaId\":999},{\"personaValue\":\"Engineers\",\"personaId\":1000}]",
        "userId": [
            17355
        ],
        "startDate": "2024-06-30T18:30:00.000Z",
        "endDate": "2024-07-30T18:30:00.000Z",
        "roadmapId": 0,
        "businessObjectiveId": 0,
        "swimlaneId": 0,
        "timeBoxPlanningId": 0,
        "subTimeBoxPlanningId": 0,
        "storyMapId": 0,
        "features": [],
        "userStories": [],
        "user": [],
        "progressPercentage": 0,
        "kpis": [
            {
                "id": 7557,
                "title": "Employee retention",
                "benchmark": "50.00",
                "benchmarkUnit": "%",
                "benchmarkType": "MORE",
                "initiativeId": 1116,
                "dueDate": null,
                "statement": "",
                "createdAt": "2024-07-12T02:24:12.000Z",
                "visualization": false,
                "dashboardVisualization": true,
                "order": 11,
                "kpiId": 7557,
                "name": "Employee retention",
                "value": "",
                "kpi_revisions": []
            },
            {
                "id": 7558,
                "title": "Churn",
                "benchmark": "30.00",
                "benchmarkUnit": "%",
                "benchmarkType": "MORE",
                "initiativeId": 1116,
                "dueDate": null,
                "statement": "",
                "createdAt": "2024-07-12T02:41:32.000Z",
                "visualization": false,
                "dashboardVisualization": true,
                "order": 12,
                "kpiId": 7558,
                "name": "Churn",
                "value": "",
                "kpi_revisions": []
            },
            {
                "id": 7559,
                "title": "hello",
                "benchmark": "0.00",
                "benchmarkUnit": "",
                "benchmarkType": "",
                "initiativeId": 1116,
                "dueDate": null,
                "statement": "",
                "createdAt": "2024-07-12T02:44:56.000Z",
                "visualization": false,
                "dashboardVisualization": true,
                "order": 13,
                "kpiId": 7559,
                "name": "hello",
                "value": "0",
                "kpi_revisions": []
            },
            {
                "id": 7563,
                "title": "Increase customer retention",
                "benchmark": "40.00",
                "benchmarkUnit": "%",
                "benchmarkType": "MORE",
                "initiativeId": 1116,
                "dueDate": "2024-07-12T18:30:00.000Z",
                "statement": "11",
                "createdAt": "2024-07-12T02:51:29.000Z",
                "visualization": true,
                "dashboardVisualization": true,
                "order": 15,
                "kpiId": 7563,
                "name": "Increase customer retention",
                "value": "11",
                "kpi_revisions": [
                    {
                        "id": 3275,
                        "createdAt": "2024-07-12T02:51:29.000Z",
                        "value": "11.00"
                    }
                ]
            },
            {
                "id": 7564,
                "title": "Increase customer retention",
                "benchmark": "40.00",
                "benchmarkUnit": "%",
                "benchmarkType": "MORE",
                "initiativeId": 1116,
                "dueDate": "2024-07-12T18:30:00.000Z",
                "statement": "11",
                "createdAt": "2024-07-12T02:54:01.000Z",
                "visualization": true,
                "dashboardVisualization": true,
                "order": 16,
                "kpiId": 7564,
                "name": "Increase customer retention",
                "value": "11",
                "kpi_revisions": [
                    {
                        "id": 3276,
                        "createdAt": "2024-07-12T02:54:01.000Z",
                        "value": "11.00"
                    }
                ]
            }
        ]
    }
}

Modified at 2024-07-12 02:15:29

Modify an epic

Removes the epic