Flocknote API - lists

« Back to Flocknote API Documentation home

Get a particular list

GET /lists/[id]

Accessing the lists object with a particular ID will return a the following JSON:

{
  "id" : "289",
  "type" : "list",
  "title" : "List Title",
  "author" : "114",
  "created" : "1279514118",
  "changed" : "1337798048",
  "description" : "An example list description.",
  "picture" :
    {
      "large" : "http:\/\/www.flocknote.com\/path\/to\/picture.png",
      "medium" : "http:\/\/www.flocknote.com\/path\/to\/picture.png",
      "small" : "http:\/\/www.flocknote.com\/path\/to\/picture.png"
    },
  "category" : "Other",
  "network" : "246",
  "permissions" :
    {
      "add" : false,
      "edit" : true,
      "remove" : true,
      "add_note" : true
    },
  "subscribed" : true
}

The returned JSON includes an array of permissions, identifying what operations the member requesting the list can perform. (The 'add' permission means the member may add new lists to this list's Network.)

Example — Get a list using Flocknote's SDK for PHP:

require_once('flocknote.php');
 
if ($flocknote = new Flocknote(APINAME, APIKEY)) {
  // Set the username and password for this request.
  $flocknote->setUserCredentials(USERNAME, PASSWORD);
 
  // Get a list.
  $list = $flocknote->getList(289);
}

Get the member's permissions for a particular list

GET /lists/[id]/permissions

Accessing the lists object with a particular ID and the submethod permissions will return a JSON array with the current member's permissions for this list.

{
  "add" : false
  "edit" : true
  "remove" : true
  "add_note" : true
}

Example — Get the member's list permissions using Flocknote's SDK for PHP:

require_once('flocknote.php');
 
if ($flocknote = new Flocknote(APINAME, APIKEY)) {
  // Set the username and password for this request.
  $flocknote->setUserCredentials(USERNAME, PASSWORD);
 
  // Get a member's list permissions.
  $permissions = $flocknote->getListPermissions(289);
}

Get a particular list's members

GET /lists/[id]/members

Accessing the lists object with a particular ID and the submethod members will return an array of JSON data with each member's information. Member listings may only be accessed by Network and List admins.

NOTE: This method and its return value are subject to change.

Example — Get a list's members using Flocknote's SDK for PHP:

require_once('flocknote.php');
 
if ($flocknote = new Flocknote(APINAME, APIKEY)) {
  // Set the username and password for this request.
  $flocknote->setUserCredentials(USERNAME, PASSWORD);
 
  // Get a list's members.
  $members = $flocknote->getListMembers(289);
}

Get a particular list's latest notes

GET /lists/[id]/notes

Accessing the lists object with a particular ID and the submethod notes will return an array of JSON data with the list's latest notes.

NOTE: At this time, there is no way to retrieve additional notes beyond the initial 25 returned by this endpoint, but there will soon be additional query parameters that will allow retrieval of older notes, or notes in a particular date range.

Example — Get a list's latest notes using Flocknote's SDK for PHP:

require_once('flocknote.php');
 
if ($flocknote = new Flocknote(APINAME, APIKEY)) {
  // Set the username and password for this request.
  $flocknote->setUserCredentials(USERNAME, PASSWORD);
 
  // Get a list's notes.
  $notes = $flocknote->getListNotes(289);
}