Flocknote API

Uno Flocknote API

Flocknote's RESTful JSON API allows external applications and websites to interact with Flocknote in a variety of ways. It can be used with any language capable of performing standard HTTP requests, though we provide SDKs for some languages, like PHP and Objective-C.

The API is structured so you can interact with top level objects like networks, lists, notes, replies and members. For example, requesting the endpoint /api/lists/123/permissions will return a JSON array of permissions for the member for whom you're making the request.

Software Development Kits

While it's easy enough to use Flocknote's API with cURL or your favorite HTTP library, we've created some great SDKs that make interacting with the Flocknote API even simpler:

  • Flocknote SDK for PHP
  • Flocknote SDK for iOS/Objective-C (coming soon!)
  • Flocknote SDK for Android/Java (on our radar)

Flocknote Integrations for Websites

API Request objects/endpoints

Currently supported objects include:

Please click on one of the objects to read documentation for supported object methods and request and response formats.

Authentication

Every app or website that interacts with Flocknote's API needs to have a unique identifier (app_id) and key (key), passed along with each API request as URI parameters.

Each API request must be made on behalf of a particular Flocknote user. Every request must include the username (user - a person's email address or phone number) and password (pass). Note that you should never store passwords in plain text in any easily-retrievable manner. Read Flocknote's Password Guidelines for more information about user credential security.

Please contact Flocknote Support for help in acquiring an API access token for your website or application.

Making an API Request

Flocknote's API follows conventional RESTful principles, and uses the verbs GET, POST, PUT, and DELETE to retrieve, submit, update, and remove objects, respectively. Each API request is authenticated with four query parameters: app_id, key, user and pass. All API interactions must be performed via SSL-encrypted connections, and requests to http:// will fail.

Here's a quick overview of a typical Flocknote API GET request URI:

https://www.flocknote.com/api/[object]/[id]/[submethod]
  ?app_id=[your_app_id]
  &key=[your_app_key]
  &user=[member_username]
  &pass=[member_password]

For certain requests, you simply add in a request body with JSON appropriate to the request. For example, when adding a new member to a list, put the following JSON array in the request body:

{
  "email" : "johndoe@example.com",
  "list_id" : 123,
}

Read about the different HTTP request types (GET, POST, PUT and DELETE) Flocknote supports.

Rate Limiting

Flocknote limits the number of requests an external application may use through the use of rate limiting. Normal API applications are limited to a maximum of 200 requests per hour.

If that limit is reached, further requests will be declined with the HTTP status 429 - Too Many Requests and the ErrorMessage This app is currently over its hourly rate limit. Please wait and try again. in the body of the response.

If your application needs a higher limit, please contact Flocknote Support to request the increase.

More Information

You can follow along with API development, Flocknote site feature development, and more by doing the following: