API Specification

These pages detail the raw Simplelists API protocol. This is for programmers only! If available, it is recommended that you use a pre-written module for your particular application. Please follow a link below for more information.

Version 2 API

Our latest API is version 2. We recommend trying this version for any new API interface with Simplelists.

Authentication

Authenticating with API version 2 is performed using Authorization header keys. Visit the Authentication documentation for full details.

Protocol

Once authenticated, read about the API protocol for version 2 for details of how to use API calls to read and write data.

Grouped account management

For special grouped accounts (avaiable by exception), read about the API protocol for grouped accounts

Version 1 API

This is our legacy API version, maintained for security and bug fixes only. We recommend consideration of version 2 for any new or updated API interface with Simplelists.

Authentication

Authenticating with the API is performed using OAuth2. Visit the Authentication documentation for full details.

Protocol

Once authenticated, read about the API protocol for details of how to use API calls to read and write data.

Examples

Look at the examples to see example PHP code of authenticating and making API calls.