MEmendix
stories

Get stories by the app ID

Returns an array of stories.

get/projects/{appId}/stories

Request

  • Base URL
    https://epics-api.mendix.com/v1
  • Auth
    API key in header Authorization

Path parameters

appIdstring uuid required

The ID of the app

Query parameters

limitinteger

The maximum number of stories that can be returned per request. If the total number of the stories retrieved is more than this limit, then in the response you can find links to pages for retrieving subsequent stories.

offsetinteger

The offset is the zero-based index of the first story to be returned on the page.

Response

Successful operation

totalStoriesinteger
limitinteger
offsetinteger

Example response

{
  "stories": [
    {
      "uuid": "346a2cad-6b96-477a-9225-3957b73ctest",
      "storyId": "TEST-1",
      "title": "Users need to have a homepage that gives them access to pages where information can be seen.",
      "descriptionHTML": "<p>Add buttons to the existing homepage which give users access to other pages.</p>",
      "descriptionPlain": "Add buttons to the existing homepage which give users access to other pages.",
      "storyPoints": 5,
      "storyType": "Feature",
      "storyLevel": "Active",
      "numberOfTasks": 1,
      "status": "Done"
    }
  ],
  "totalStories": 1,
  "links": [
    {
      "rel": "current",
      "hRef": "https://epics-api.mendix.com/v1/projects/346a2cad-6b96-477a-9225-3957b73ctpro/{tag}?limit=20&offset=120"
    }
  ],
  "limit": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.