Contents

API reference


This document defines the REST API specifications for Sticky Notes. The API has three main endpoints: create, show and list and a utility endpoint called parameter. For each endpoint, there is a set of mandatory and optional parameters and a standard output template depending upon the requested format for the response.

You can find an implementation of the REST API in the api-client branch on GitHub.

Creating new pastes

The create endpoint can be used for creating a new paste from your application.

Mandatory parameters

Optional parameters

Return values on success

URLs can be framed as http://yoursite.com/<id> for public pastes and http://yoursite.com/<id>/<hash> for private pastes.

Return values on error

Show paste

The show endpoint can be used for returning a paste by its unique identifier.

Return values on success

Return values on error

List pastes

The list endpoint can be used for getting a list of pastes IDs.

Return values on success

Return values on error

Parameter values

The parameter endpoint will provide you a list of values associated with a specific parameter. The parameters might be used as an input to certain API endpoints, or can purely be for informational purposes.

Return values on success

Return values on error