Help & Support
Follow

Advanced Reporting API: Cards

GET /io/reporting/export/cards

Returns all the current cards the authorized user has access to.

Resource URL

GET https://{accountname}.leankit.com/io/reporting/export/cards?token=xyzyz

Resource information

Requires auth token? Yes
Response formats CSV, TAB, or JSON

Parameters

Name Required Description
token Yes A valid token obtained from the POST /io/reporting/auth API end point.
format No Values: csv, tab, json
Default: csv
header No Values: true, false, 1, 0
When header=true the first row returned is the list of field names. Only applies when format is csv or tab.
Default: true
quotedString No Values: true, false, 1, 0
When quotedString=true all strings are surrounded by quotes. Only applies when format is csv or tab.
Note: if quotedString=false and a value contains the delimiter (comma), quotes will be added around the field value.
Default: true
quoted No Values: true, false, 1, 0
When quoted=true all values are surrounded by quotes, except for empty/missing values. Only applies when format is csv or tab.
Default: false
quotedEmpty No Values: true, false, 1, 0
When quotedEmpty=true all empty/missing values are represented as empty quotes ("").
Default: false
limit No Value: any postive number
Default: 1000000 when format is csv or tab, 100 when format is json
offset No Value: any postive number
Default: 0

Example request

GET https://myaccount.leankit.com/io/reporting/export/cards?token=xyxyz

Response

Column Description
Card ID  
External Card ID  
Card Title  
Card Type  
Card Size  
Priority  
Custom Icon  
Is Card Blocked  
Current Blocked Reason  
Card External Link Name  
Card External Link Url  
Creation Date  
Planned Start Date  
Actual Start Date  
Planned Finish Date  
Actual Finish Date  
Attachments Count  
Last Attachment Date  
Comments Count  
Last Comment Date  
Last Activity Date  
Archived Date  
Last Moved Date  
Current Lane ID  
Current Lane Title  
Parent Lane Title  
Current Lane Type  
Current Board ID  
Current Board Title  

Example response

"Card ID","External Card ID","Card Title","Card Type","Card Size","Priority","Custom Icon","Is Card Blocked","Current Blocked Reason","Card External Link Name","Card External Link Url","Creation Date","Planned Start Date","Actual Start Date","Planned Finish Date","Actual Finish Date","Attachments Count","Last Attachment Date","Comments Count","Last Comment Date","Last Activity Date","Archived Date","Last Moved Date","Current Lane ID","Current Lane Title","Parent Lane Title","Current Lane Type","Current Board ID","Current Board Title"
"10112913458",,"1","Other Work",0,"Normal",,,,,,2016-06-27 04:04:50 PM,,2016-06-27 04:06:25 PM,,2016-06-27 04:06:25 PM,0,,0,,2016-06-27 04:06:25 PM,2016-06-27 04:06:25 PM,2016-06-27 04:06:25 PM,"10112913867","Finished As Planned","Finished - Ready to Archive","Not Set","10112913759","Sample Board 1"
"10112913459",,"2","Other Work",0,"Normal",,,,,,2016-06-27 04:04:52 PM,,2016-06-27 04:06:25 PM,,2016-06-27 04:06:25 PM,0,,0,,2016-06-27 04:06:25 PM,2016-06-27 04:06:25 PM,2016-06-27 04:06:25 PM,"10112913867","Finished As Planned","Finished - Ready to Archive","Not Set","10112913759","Sample Board 1"

Sample JavaScript AJAX request to export current cards

const rootHostUrl = "https://myaccount.leankit.com";
const basePath = `${ rootHostUrl }/io/reporting`;
const auth = {
    email: "my_user@leankit.com",
    password: "my_password",
    accountName: "myaccount"
};
$.ajax(
    {
        method: "POST",
        url: `${ basePath }/auth`,
        success: function( data, textStatus, jqXHR ) {
            const token = JSON.parse( data ).token;
            const dataUrl = `${ basePath }/export/cards?token=${ token }`;
            $.ajax(
                {
                    url: dataUrl,
                    dataType: "text",
                    success: function( cardsResponseData, t2, j2 ) {
                    },
                    error: function( jqXHR, textStatus, errorThrown ) {
                        debugger;
                    }
                } );
        },
        error: function( jqXHR, textStatus, errorThrown ) {
            debugger;
        },
        contentType: "application/json",
        dataType: "text",
        data: JSON.stringify( { email: auth.email, password: auth.password, accountName: auth.accountName } )
    } );
Have more questions? Submit a request