Overview

Build and integrate tools and applications to help members manage their lists.

This is the official documentation for RenaList API. A reference to the functionality our public API provides with detailed description of each API endpoint, parameters, and examples

Format

API endpoints accept arguments either as json-encoded objects encoded in POST request body with Content-Type: application/json header.

Where possible, the API strives to use appropriate HTTP verbs for each action.

Verb	Description
GET	Used for retrieving resources.
POST	Used for creating resources.
PUT	Used for updating resources, or performing custom actions.
DELETE	Used for deleting resources.

This API relies on standard HTTP response codes to indicate operation result. The table below is a simple reference about the most used status codes:

Status code	Description
200	The request was processed successfully.
204	The request was processed successfully without any data to return.
4xx	The request was processed with an error and should not be retried unmodified as they won’t be processed any different by an API.
5xx	The request failed due to a server error, it’s safe to retry later.

All 200 OK responses have the Content-type: application/json and contain a JSON-encoded representation of one or more objects.

Payload of POST requests has to be JSON-encoded and accompanied with Content-Type: application/json header.

Timestamps

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

CORS

The API supports Cross Origin Resource Sharing (CORS) for AJAX requests. You can read the CORS W3C recommendation, or this intro from the HTML 5 Security Guide.

Here’s a sample request sent from a browser hitting http://example.com:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: http://example.com
Access-Control-Expose-Headers: ETag, Content-Type, Accept, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
Access-Control-Allow-Credentials: true