Get a list of increments for a planning series

GET /io/series/:seriesId/increment

Get a list of increments and child increments for a planning series.

Query Params

Param Type Usage Default
offset integer Set the "start row" number of the first card to be returned. 0
limit integer Set the number of cards to be returned. 200
sortBy enumeration Set the ordering of the results. dateAsc

Valid sortBy options:

  • dateDesc
  • dateAsc

Example Requests

view sourceprint?
1curl -X GET \
2  https://myaccount.leankit.com/io/series/12345/increment \
3  -H 'Authorization: Basic base64encodedauthhere'
4 
5curl -X GET \
6  https://myaccount.leankit.com/io/series/12345/increment?sortBy=dateDesc&limit=1&offset=1 \
7  -H 'Authorization: Basic base64encodedauthhere'

Example successful response

view sourceprint?
01200 OK
02 
03{
04    "pageMeta": {
05        "totalRecords": 2,
06        "offset": 0,
07        "limit": 100,
08        "startRow": 1,
09        "endRow": 2
10    },
11    "increments": [
12        {
13            "id": "1014169191",
14            "label": "PI-1",
15            "planningSeriesId": "12345",
16            "startDate": "2021-10-01",
17            "endDate": "2021-11-15",
18            "parentPlanningIncrementId": null
19            "increments" [
20                {
21                    "id": "1014170402",
22                    "label": "Sub-1",
23                    "planningSeriesId": "12345",
24                    "startDate": "2022-02-01",
25                    "endDate": "2022-02-14",
26                    "parentPlanningIncrementId": "1014169191"
27                },
28                {
29                    "id": "1014170403",
30                    "label": "Sub-2",
31                    "planningSeriesId": "12345",
32                    "startDate": "2022-02-15",
33                    "endDate": "2022-02-28",
34                    "parentPlanningIncrementId": "1014169191"
35                }
36            ]
37        },
38        {
39            "id": "1014170401",
40            "label": "PI-2",
41            "planningSeriesId": "12345",
42            "startDate": "2022-02-01",
43            "endDate": "2022-02-28",
44            "parentPlanningIncrementId": null,
45            "increments": []
46        }
47    ]
48}