{"id":12136,"date":"2016-02-17T13:36:48","date_gmt":"2016-02-17T19:36:48","guid":{"rendered":"https:\/\/blog.planview.com\/?p=12136"},"modified":"2020-02-20T13:48:50","modified_gmt":"2020-02-20T19:48:50","slug":"exploring-leankit-apis-with-postman","status":"publish","type":"post","link":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/","title":{"rendered":"Exploring Planview AgilePlace APIs with Postman"},"content":{"rendered":"<p><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-12149 aligncenter\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg\" alt=\"\" width=\"891\" height=\"501\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg 800w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi-300x169.jpg 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi-768x432.jpg 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi-750x422.jpg 750w\" sizes=\"auto, (max-width: 891px) 100vw, 891px\" \/><\/p>\n<p>There&#8217;s a wealth of information available to every Planview AgilePlace user through the use of the\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Planview AgilePlace Application Programming Interface (API)<\/a>. The API can be used to extract status information for a custom report, automate routine tasks such as moving or updating a card, synchronize data with another system, and many other useful tasks.<\/p>\n<p>However, if you&#8217;ve never worked with an API before, getting started can be a little overwhelming. Thankfully, there are great tools available to make it easier. In this article, we are going to look at one of my favorite API tools,\u00a0<a title=\"\" href=\"http:\/\/www.getpostman.com\/\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Postman<\/a>.<\/p>\n<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_82_2 counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\" style=\"cursor:inherit\">Table of Contents<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"Toggle Table of Content\"><span class=\"ez-toc-js-icon-con\"><span class=\"\"><span class=\"eztoc-hide\" style=\"display:none;\">Toggle<\/span><span class=\"ez-toc-icon-toggle-span\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#Getting_Postman\" >Getting Postman<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#Making_your_first_API_request\" >Making your first API request<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#Request_a_single_board\" >Request a single board<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#Search_for_cards\" >Search for cards<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#How_to_update_a_card\" >How to update a card<\/a><\/li><\/ul><\/nav><\/div>\n<h2 id=\"gettingpostman\"><span class=\"ez-toc-section\" id=\"Getting_Postman\"><\/span>Getting Postman<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>If you have\u00a0<a title=\"\" href=\"https:\/\/www.google.com\/chrome\/\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Google Chrome<\/a>, you can get Postman as a\u00a0<a title=\"\" href=\"https:\/\/chrome.google.com\/webstore\/detail\/postman\/fhbjgbiflinjbdggehcddcbncdddomop\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Chrome extension<\/a>. If you are on a Mac, you can get Postman as a\u00a0<a title=\"\" href=\"https:\/\/www.getpostman.com\/app\/postman-osx-beta\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">desktop application<\/a>. I expect Postman to release a Windows desktop app in the future.<\/p>\n<p>Once installed, you should see the request &#8220;Builder&#8221; screen.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12137\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-39-02.png\" alt=\"\" width=\"987\" height=\"312\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-39-02.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-39-02-300x95.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-39-02-768x243.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-39-02-750x237.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<h2 id=\"makingyourfirstapirequest\"><span class=\"ez-toc-section\" id=\"Making_your_first_API_request\"><\/span>Making your first API request<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>For your first API request, we are going to retrieve a\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">list of boards<\/a>\u00a0from your account.<\/p>\n<h3 id=\"enteryouraccounturlandcredentials\">Enter your account URL and credentials<\/h3>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12138\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-30-44.png\" alt=\"\" width=\"987\" height=\"402\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-30-44.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-30-44-300x122.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-30-44-768x313.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-30-44-750x305.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<ol>\n<li>Enter the URL for the request. In this example, the URL is\u00a0<code>https:\/\/demoarea.leankit.com\/kanban\/api\/boards<\/code>. We will need to replace\u00a0<code>demoarea<\/code>\u00a0with the name of our Planview AgilePlace account.<\/li>\n<li>Click on the Authorization tab, if it is not already selected.<\/li>\n<li>Change &#8220;No Auth&#8221; to &#8220;Basic Auth.&#8221;<\/li>\n<li>Enter your account email address and password.<\/li>\n<li>Click the &#8220;Update request&#8221; button.<\/li>\n<\/ol>\n<h3 id=\"updatetherequestheaders\">Update the request headers<\/h3>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12139\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-31-56-1.png\" alt=\"\" width=\"987\" height=\"321\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-31-56-1.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-31-56-1-300x98.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-31-56-1-768x250.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-31-56-1-750x244.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<ol>\n<li>Click on the Headers tab.<\/li>\n<li>Add two headers:\u00a0<code>Content-Type<\/code>\u00a0and\u00a0<code>Accept<\/code>\u00a0with the value\u00a0<code>application\/json<\/code>.<\/li>\n<\/ol>\n<p>Setting the\u00a0<code>Content-Type<\/code>\u00a0and\u00a0<code>Accept<\/code>\u00a0headers lets the API know that any data we send will be\u00a0<a title=\"\" href=\"https:\/\/en.wikipedia.org\/wiki\/JSON\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">JavaScript Object Notation<\/a>\u00a0(JSON) format, and any data returned should also be in JSON format.<\/p>\n<h3 id=\"submittherequest\">Submit the request<\/h3>\n<p>We are now ready to make the request! Click the &#8220;Send&#8221; button. As long as the URL and account information is correct, we should see something like the following image.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12140\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-32-39.png\" alt=\"\" width=\"987\" height=\"512\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-32-39.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-32-39-300x156.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-32-39-768x398.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-32-39-750x389.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<p>A response from the API will almost always be in the following format:<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12141\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture.png\" alt=\"\" width=\"675\" height=\"125\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture.png 675w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture-300x56.png 300w\" sizes=\"auto, (max-width: 675px) 100vw, 675px\" \/><\/p>\n<p>We should now have a list of boards that includes each board&#8217;s\u00a0<code>Id<\/code>,\u00a0<code>Title<\/code>,\u00a0<code>Description<\/code>,\u00a0<code>CreationDate<\/code>\u00a0(date the board was created), and other basic information.<\/p>\n<h2 id=\"requestasingleboard\"><span class=\"ez-toc-section\" id=\"Request_a_single_board\"><\/span>Request a single board<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Now that we have our list of boards, we can use the\u00a0<code>Id<\/code>\u00a0of a board to\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">get a single board<\/a>\u00a0with all its details, such as users, lanes, and cards.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12142\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-33-47.png\" alt=\"\" width=\"987\" height=\"513\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-33-47.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-33-47-300x156.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-33-47-768x399.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-33-47-750x390.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<ol>\n<li>From the list of boards in the previous request, let&#8217;s copy the\u00a0<code>Id<\/code>\u00a0of a board. Update the request URL by adding to the end a slash (<code>\/<\/code>) and the\u00a0<code>Id<\/code>\u00a0of board we copied. Our request URL should look something like:\u00a0<code>https:\/\/myaccount.leankit.com\/kanban\/api\/boards\/1234<\/code>.<\/li>\n<li>Click the &#8220;Send&#8221; button.<\/li>\n<\/ol>\n<h3 id=\"collapseblocksofdata\">Collapse blocks of data<\/h3>\n<p>Postman not only formats the JSON data to make it more readable, it makes it easy to collapse sections data so you can focus on the information you care about. To collapse or expand blocks of data, click the arrow to the left.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12143\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-34-25.png\" alt=\"\" width=\"987\" height=\"510\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-34-25.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-34-25-300x155.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-34-25-768x397.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_10-34-25-750x388.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<h3 id=\"savetherequest\">Save the request<\/h3>\n<p>One of the nice features of Postman is the ability to save requests, so we can reuse them later. Let&#8217;s save the request for the board so we don&#8217;t have to go through all those previous steps in the future.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12144\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_12-45-31.png\" alt=\"\" width=\"973\" height=\"522\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_12-45-31.png 973w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_12-45-31-300x161.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_12-45-31-768x412.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-03_12-45-31-750x402.png 750w\" sizes=\"auto, (max-width: 973px) 100vw, 973px\" \/><\/p>\n<ol>\n<li>Click the save button.<\/li>\n<li>Choose a collection or create a new collection. A collection is like a folder to store your requests. We can create a new collection by entering a name under &#8220;&#8230;or create a new one.&#8221;<\/li>\n<li>Enter a descriptive name for the request.<\/li>\n<li>Click the &#8220;Add to collection&#8221; button.<\/li>\n<\/ol>\n<h2 id=\"searchforcards\"><span class=\"ez-toc-section\" id=\"Search_for_cards\"><\/span>Search for cards<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>For our next trick, we are going to\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">search for cards<\/a>.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12145\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_10-49-16-1.png\" alt=\"\" width=\"987\" height=\"465\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_10-49-16-1.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_10-49-16-1-300x141.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_10-49-16-1-768x362.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_10-49-16-1-750x353.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<ol>\n<li>Change the request type from GET to POST.<\/li>\n<li>Update the URL of the request, changing\u00a0<code>myaccount<\/code>\u00a0to match our account name, and\u00a0<code>1234<\/code>\u00a0to match our board ID.\n<p><code>https:\/\/myaccount.leankit.com\/kanban\/api\/board\/1234\/searchcards<\/code><\/p>\n<p><em>Note:<\/em><code>\/board\/<\/code>\u00a0in this URL is singular instead of plural, as in previous requests.<\/li>\n<li>Click on the &#8220;Body&#8221; tab.<\/li>\n<li>Select the &#8220;raw&#8221; body format.<\/li>\n<li>Update the body with the following JSON:\n<p><code>{ \"searchOptions\": { \"SearchTerm\": \"Sales\", \"Page\": 1 } }<\/code><\/p>\n<p><em>Note:<\/em>\u00a0Change the\u00a0<code>SearchTerm<\/code>\u00a0to any text that would match the title or description of a card on your board. A list of all search and filter options is available in the\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Search Cards<\/a>\u00a0documentation.<\/li>\n<li>Click &#8220;Send&#8221; to submit the request.<\/li>\n<\/ol>\n<h3 id=\"searchresults\">Search results<\/h3>\n<p>It&#8217;s important to point out that the JSON returned by the card search includes the following information.<\/p>\n<table>\n<thead>\n<tr>\n<th>Property<\/th>\n<th>Value<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>TotalResults<\/strong><\/td>\n<td>The total number of cards that matched the search.<\/td>\n<\/tr>\n<tr>\n<td><strong>Page<\/strong><\/td>\n<td>The current &#8220;Page&#8221; or results.<\/td>\n<\/tr>\n<tr>\n<td><strong>MaxResults<\/strong><\/td>\n<td>The maximum number of cards returned by the search request.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<p>If the number of cards that match your search exceeds the\u00a0<code>MaxResults<\/code>, your results will be split up into &#8220;Pages&#8221; that require separate requests.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12146\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_12-22-52.png\" alt=\"\" width=\"987\" height=\"521\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_12-22-52.png 987w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_12-22-52-300x158.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_12-22-52-768x405.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_12-22-52-750x396.png 750w\" sizes=\"auto, (max-width: 987px) 100vw, 987px\" \/><\/p>\n<p>For example, if our search matched 33 cards (<code>\"TotalResults\": 33<\/code>), only the first 20 cards will be returned. To get the other 13 cards, we must change the body of the request to the following, and submit again.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12147\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture-1.png\" alt=\"\" width=\"676\" height=\"145\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture-1.png 676w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/Capture-1-300x64.png 300w\" sizes=\"auto, (max-width: 676px) 100vw, 676px\" \/><\/p>\n<h2 id=\"howtoupdateacard\"><span class=\"ez-toc-section\" id=\"How_to_update_a_card\"><\/span>How to update a card<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>For the next example, we are going to\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">update a card<\/a>. We can change most of the information on a card, such as the title, description, planned start date, planned finish date, and assigned users, to name a few.<\/p>\n<p>At minimum, we need to know the card&#8217;s ID. We can get this ID a few different ways. We can use the API to get the board or search cards, as in the previous examples, or we can find the card ID on the card itself in the bottom, right-hand corner.<\/p>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"alignnone size-full wp-image-12148\" src=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41.png\" alt=\"\" width=\"2066\" height=\"1144\" srcset=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41.png 2066w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41-300x166.png 300w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41-768x425.png 768w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41-1024x567.png 1024w, https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/2016-02-04_14-25-41-750x415.png 750w\" sizes=\"auto, (max-width: 2066px) 100vw, 2066px\" \/><\/p>\n<p>Next, we&#8217;ll update our request.<\/p>\n<ol>\n<li>Change the request type to POST.<\/li>\n<li>Update the URL of the request, changing\u00a0<code>myaccount<\/code>\u00a0to match our account name.\n<p><code>https:\/\/myaccount.leankit.com\/kanban\/api\/card\/update<\/code><\/li>\n<li>Click on the &#8220;Body&#8221; tab.<\/li>\n<li>Select the &#8220;raw&#8221; body format.<\/li>\n<li>Update the body with the following JSON:\n<p><code>{ \"CardId\": 123456, \"Title\": \"Updated using the API\" }<\/code><\/p>\n<p><em>Note:<\/em>\u00a0Change the\u00a0<code>CardId<\/code>\u00a0value to match the ID of the card you are updating, and\u00a0<code>Title<\/code>\u00a0to the desired text. Or, update a different field. A list of all updatable fields is available in the\u00a0<a title=\"\" href=\"https:\/\/success.planview.com\/Planview_LeanKit\/LeanKit_API\" target=\"_blank\" rel=\"noopener noreferrer\" data-ol-has-click-handler=\"\">Update Card<\/a>\u00a0documentation.<\/li>\n<li>Click &#8220;Send&#8221; to submit the request.<\/li>\n<\/ol>\n<p>If successful, the API response will include the updated card information.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>There&#8217;s a wealth of information available to every Planview AgilePlace user through the use of the\u00a0Planview AgilePlace Application Programming Interface (API). The API can be used to extract status information for a custom report, automate routine tasks such as moving or updating a card, synchronize data with another system, and many other useful tasks. However,&#8230;<\/p>\n","protected":false},"author":47,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"_editorskit_title_hidden":false,"_editorskit_reading_time":0,"_editorskit_is_block_options_detached":false,"_editorskit_block_options_position":"{}","footnotes":""},"categories":[38],"tags":[511],"class_list":["post-12136","post","type-post","status-publish","format-standard","hentry","category-work-collaboration","tag-leankit"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v27.4 (Yoast SEO v27.4) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>Exploring LeanKit APIs with Postman - Blog | Planview<\/title>\n<meta name=\"description\" content=\"There&#039;s a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Exploring Planview AgilePlace APIs with Postman\" \/>\n<meta property=\"og:description\" content=\"There&#039;s a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).\" \/>\n<meta property=\"og:url\" content=\"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/\" \/>\n<meta property=\"og:site_name\" content=\"Planview Blog\" \/>\n<meta property=\"article:publisher\" content=\"http:\/\/www.facebook.com\/pages\/Planview-Inc\/89422974772\" \/>\n<meta property=\"article:published_time\" content=\"2016-02-17T19:36:48+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-02-20T19:48:50+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg\" \/>\n<meta name=\"author\" content=\"Planview Blog\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@Planview\" \/>\n<meta name=\"twitter:site\" content=\"@Planview\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Planview Blog\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"5 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/\"},\"author\":{\"name\":\"Planview Blog\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#\\\/schema\\\/person\\\/fd58aa7028c738371555a4f6fe4032f4\"},\"headline\":\"Exploring Planview AgilePlace APIs with Postman\",\"datePublished\":\"2016-02-17T19:36:48+00:00\",\"dateModified\":\"2020-02-20T19:48:50+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/\"},\"wordCount\":969,\"publisher\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#organization\"},\"image\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2020\\\/02\\\/LeanKit-APi.jpg\",\"keywords\":[\"LeanKit\"],\"articleSection\":[\"Work Management for Teams\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/\",\"name\":\"Exploring LeanKit APIs with Postman - Blog | Planview\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#primaryimage\"},\"image\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#primaryimage\"},\"thumbnailUrl\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2020\\\/02\\\/LeanKit-APi.jpg\",\"datePublished\":\"2016-02-17T19:36:48+00:00\",\"dateModified\":\"2020-02-20T19:48:50+00:00\",\"description\":\"There's a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#primaryimage\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2020\\\/02\\\/LeanKit-APi.jpg\",\"contentUrl\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2020\\\/02\\\/LeanKit-APi.jpg\",\"width\":800,\"height\":450},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/exploring-leankit-apis-with-postman\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/blog.planview.com\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Exploring LeanKit APIs with Postman\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#website\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/\",\"name\":\"Planview Blog\",\"description\":\"Leading the conversation on digital connected work\",\"publisher\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/blog.planview.com\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#organization\",\"name\":\"Planview\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2015\\\/06\\\/planview-logo-black.png\",\"contentUrl\":\"https:\\\/\\\/blog.planview.com\\\/wp-content\\\/uploads\\\/2015\\\/06\\\/planview-logo-black.png\",\"width\":280,\"height\":66,\"caption\":\"Planview\"},\"image\":{\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#\\\/schema\\\/logo\\\/image\\\/\"},\"sameAs\":[\"http:\\\/\\\/www.facebook.com\\\/pages\\\/Planview-Inc\\\/89422974772\",\"https:\\\/\\\/x.com\\\/Planview\"]},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/blog.planview.com\\\/#\\\/schema\\\/person\\\/fd58aa7028c738371555a4f6fe4032f4\",\"name\":\"Planview Blog\",\"url\":\"https:\\\/\\\/blog.planview.com\\\/author\\\/planviewblog\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Exploring LeanKit APIs with Postman - Blog | Planview","description":"There's a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/","og_locale":"en_US","og_type":"article","og_title":"Exploring Planview AgilePlace APIs with Postman","og_description":"There's a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).","og_url":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/","og_site_name":"Planview Blog","article_publisher":"http:\/\/www.facebook.com\/pages\/Planview-Inc\/89422974772","article_published_time":"2016-02-17T19:36:48+00:00","article_modified_time":"2020-02-20T19:48:50+00:00","og_image":[{"url":"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg","type":"","width":"","height":""}],"author":"Planview Blog","twitter_card":"summary_large_image","twitter_creator":"@Planview","twitter_site":"@Planview","twitter_misc":{"Written by":"Planview Blog","Est. reading time":"5 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#article","isPartOf":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/"},"author":{"name":"Planview Blog","@id":"https:\/\/blog.planview.com\/#\/schema\/person\/fd58aa7028c738371555a4f6fe4032f4"},"headline":"Exploring Planview AgilePlace APIs with Postman","datePublished":"2016-02-17T19:36:48+00:00","dateModified":"2020-02-20T19:48:50+00:00","mainEntityOfPage":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/"},"wordCount":969,"publisher":{"@id":"https:\/\/blog.planview.com\/#organization"},"image":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#primaryimage"},"thumbnailUrl":"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg","keywords":["LeanKit"],"articleSection":["Work Management for Teams"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/","url":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/","name":"Exploring LeanKit APIs with Postman - Blog | Planview","isPartOf":{"@id":"https:\/\/blog.planview.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#primaryimage"},"image":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#primaryimage"},"thumbnailUrl":"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg","datePublished":"2016-02-17T19:36:48+00:00","dateModified":"2020-02-20T19:48:50+00:00","description":"There's a wealth of information available to every LeanKit user through the use of the LeanKit Application Programming Interface (API).","breadcrumb":{"@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#primaryimage","url":"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg","contentUrl":"https:\/\/blog.planview.com\/wp-content\/uploads\/2020\/02\/LeanKit-APi.jpg","width":800,"height":450},{"@type":"BreadcrumbList","@id":"https:\/\/blog.planview.com\/exploring-leankit-apis-with-postman\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/blog.planview.com\/"},{"@type":"ListItem","position":2,"name":"Exploring LeanKit APIs with Postman"}]},{"@type":"WebSite","@id":"https:\/\/blog.planview.com\/#website","url":"https:\/\/blog.planview.com\/","name":"Planview Blog","description":"Leading the conversation on digital connected work","publisher":{"@id":"https:\/\/blog.planview.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/blog.planview.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/blog.planview.com\/#organization","name":"Planview","url":"https:\/\/blog.planview.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.planview.com\/#\/schema\/logo\/image\/","url":"https:\/\/blog.planview.com\/wp-content\/uploads\/2015\/06\/planview-logo-black.png","contentUrl":"https:\/\/blog.planview.com\/wp-content\/uploads\/2015\/06\/planview-logo-black.png","width":280,"height":66,"caption":"Planview"},"image":{"@id":"https:\/\/blog.planview.com\/#\/schema\/logo\/image\/"},"sameAs":["http:\/\/www.facebook.com\/pages\/Planview-Inc\/89422974772","https:\/\/x.com\/Planview"]},{"@type":"Person","@id":"https:\/\/blog.planview.com\/#\/schema\/person\/fd58aa7028c738371555a4f6fe4032f4","name":"Planview Blog","url":"https:\/\/blog.planview.com\/author\/planviewblog\/"}]}},"_links":{"self":[{"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/posts\/12136","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/users\/47"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/comments?post=12136"}],"version-history":[{"count":0,"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/posts\/12136\/revisions"}],"wp:attachment":[{"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/media?parent=12136"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/categories?post=12136"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.planview.com\/wp-json\/wp\/v2\/tags?post=12136"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}