Consumer Notebook API Documentation

Welcome! Also see the Consumer Notebook Developer Center (developers.consumernotebook.com) for our graphic identity kit, featured projects, and much more.

REST API Features:

• Get Product, Grid, and List data as JSON responses.
• OAuth2 authentication so you/we can track usage.

First, read this:

• Getting Started
  • Dependencies
  • Authentication
  • Filtering
  • API Schema

Explore our REST API resources:

Products

Resource	Description
GET /api/v1/my-products/	Returns a list of products you’ve bookmarked
GET /api/v1/products/	Returns the most recent products added to Consumer Notebook.
GET /api/v1/products/{id}/	Returns the detail on a specific product.
GET /api/v1/products/schema/	Returns the structure of a Consumer Notebook product.
POST /api/v1/post-product/	Adds or bookmarks a product

Lists

Resource	Description
GET /api/v1/my-lists/	Returns your lists
GET /api/v1/lists/	Returns the most recent lists modified.
GET /api/v1/lists/{username}/{list_slug}	Returns the detail on a specific list.
POST /api/v1/post-manage-lists/	Adds a list. The list is the property of the creating user.
PUT /api/v1/post-manage-lists/	Modifies a list that you own.

Grids

Resource	Description
GET /api/v1/my-grids/	Returns your grids
GET /api/v1/grids/	Returns a list of grids in order they were created.
GET /api/v1/grids/{username}/{grid_slug}	Returns the detail on a specific grid.

Users

Resource	Description
GET /api/v1/my-profile/	Returns your profile
GET /api/v1/users/	Returns a list of users.
GET /api/v1/users/{id}	Returns the detail on a user.
GET /api/v1/users/schema/	Returns the structure of a Consumer Notebook user.
PUT /api/v1/my-profile/	Update your profile

---

Bookmarklet API

• Bookmarklet API
  • Dependencies
  • Method
  • Target
  • Parameters
  • Example

Table of Contents

• GET /api/v1/my-products/
  • Parameters
  • Example Request
• GET /api/v1/products/
  • Parameters
  • Example Request
• GET /api/v1/products/{id}/
  • Parameters
  • Example Request
• GET /api/v1/products/schema/
  • Parameters
  • Example Request
• POST /api/v1/post-product/
  • Parameters
  • Example Request
• GET /api/v1/my-lists/
  • Parameters
  • Example Request
• GET /api/v1/lists/
  • Parameters
  • Example Request
• GET /api/v1/lists/{username}/{list_slug}
  • Parameters
  • Example Request
• POST /api/v1/post-manage-lists/
  • Parameters
  • Example Request
• PUT /api/v1/post-manage-lists/
  • Parameters
  • Example Request
• GET /api/v1/my-grids/
  • Parameters
  • Example Request
• GET /api/v1/grids/
  • Parameters
  • Example Request
• GET /api/v1/grids/{username}/{grid_slug}
  • Parameters
  • Example Request
• GET /api/v1/my-profile/
  • Parameters
  • Example Request
• GET /api/v1/users/
  • Parameters
  • Example Request
• GET /api/v1/users/{id}
  • Parameters
  • Example Request
• GET /api/v1/users/schema/
  • Parameters
  • Example Request
• PUT /api/v1/my-profile/
  • Parameters
  • Example Request
• Bookmarklet API
  • Dependencies
  • Method
  • Target
  • Parameters
  • Example