FOLDERS


METHOD

/api/folders/get.php

This method gets folders from Cranked and meta data associated with it.


ENDPOINT

http://cranked_installation_url/api/folders/get.php


PARAMETERS GET

PARAMETER DEFAULT REQUIRED NOTES
api_key null Yes API key can be retrieved from /api/auth/login.php
folder_id null No If folder_id is passed into the call, data will return for this folder.
feed_id null No If feed_id is passed into the call, folder data will return for that particular feed (could be one or many folders for one feed).

SUCCESS RESPONSE

{
   "count":2,
   "all_unread_count":"2858",
   "all_saved_count":"14",
   "folder_items":[
      {
         "folder_id":"3",
         "folder_title":"Apple",
         "show_excerpt":"1",
         "show_unread_count":"1",
         "newest_first":"1",
         "unread_count":"1075"
      },
      {
         "folder_id":"5",
         "folder_title":"Design",
         "show_excerpt":"1",
         "show_unread_count":"1",
         "newest_first":"1",
         "unread_count":"1783"
      }
   ]
}

ERROR RESPONSE

ERROR MESSAGE NOTES
No data passed API was called but no data were passed
API key not passed The required API key was not passed into the call
Invalid API key The API key was passed into the call but is invalid