lists/{id}

Returns information about a given list, specified by list ID.

Resource URL

https://api.bibliocommons.com/v1/lists/{id}

Request Parameters

Parameter Type Description Default Required?
id String The list ID. N/A Yes

Response Fields

Response Field Type Description Returned Link To *
id
String The unique list ID. Always
name
String The name of the list. Always details_url
item_count
Integer The total number of items on the list. Always
created
String The date and time that the list was created. Always
updated
String The date and time that the list was last updated. Always
list_type Object The list type. Sometimes
id String The ID of the list type.
name String The user-friendly name of the list type.
user Object The user who created this list.  See users Response Fields. Always
details_url String The URL for the list details page. Always

 

list_items

 

Object[]

 

The list items contained in the list.

 

Always

list_item_type String The type of list item, either title or url. Always
annotation String The user annotation associated with this list item. Sometimes
title Object If list_item_type is title, the title contained by this list item.  See titles Response Fields. Sometimes
url Object If list_item_type is url, the url contained by this list item. Sometimes
title String The title of the page referred to by this url.
url String The URL to the page.

Example Request

GET https://api.bibliocommons.com/v1/lists/{id}?api_key={key}

Response:

{
  "list": {
    "id": "2353222",
    "name": "Classic Children's Books",
    "item_count": 2,
    "created": "2010-12-09T19:46:20Z",
    "updated": "2010-12-09T19:46:20Z",
    "list_items": [
      {
        "list_item_type": "title", 
        "title": {
          "id": "705528135",
          "title": "Alice in Wonderland",
          "format": {
            "id": "BK",
            "name": "Book"
          },
          "details_url": "http://examplepl.bibliocommons.com/item/show/705528135",
          "authors": [
            {
              "name": "Carroll, Lewis"
            }
          ],
          "isbns": [
            "0375866418",
            "9780375866418"
          ]
        }
      },
      {
        "list_item_type": "url",
        "annotation": "Check out this cool online version of Oliver Twist.",
        "url": {
          "title": "Oliver Twist by Charles Dickens.",
          "url": "http://www.online-literature.com/dickens/olivertwist/"
        }
      }      
    ]
  }
}