MEmendix
epics

Get epics by the app ID

Returns an array of epics.

get/projects/{appId}/epics

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 epics that can be returned per request. If the total number of the epics retrieved is more than this limit, then in the response you can find links to pages for retrieving subsequent epics.

offsetinteger

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

Response

Successful operation

totalEpicsinteger
limitinteger
offsetinteger

Example response

{
  "epics": [
    {
      "epicId": "EPI-TEST-1",
      "name": "Public API Initiative",
      "objective": "Ability to change stories programatically",
      "numberOfStories": 4,
      "numberOfStoryPoints": 24
    }
  ],
  "totalEpics": 240,
  "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.