DEPRECATED Blimp Public API Documentation


This describes the resources that make up the official Blimp Public API. If you have any problems or requests please contact support.

Schema

All API access is over HTTPS, and accessed from the app.getblimp.com domain. All data is sent and received as JSON. The API encourages “round-trippable” data, which means the data you can GET should be able to be POST/PUT’d back to recreate the same object. If you’re ever in question about what you should send, do a GET on another object & see what the API thinks it should look like.

Blank fields are included as null instead of being omitted.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

HTTP Verbs

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

HEAD : Can be issued against any resource to get just the HTTP header info.

GET : Used for retrieving resources.

POST : Used for creating resources.

PATCH : Used for updating resources with partial JSON data. A PATCH request may accept one or more of the attributes to update the resource. PATCH is a relatively new and uncommon HTTP verb, so resource endpoints also accept POST requests.

PUT : Used for replacing resources or collections.

DELETE : Used for deleting resources.

Authentication

For now there is only one way to authenticate. Requests that require authentication will return 404, instead of 403, in some places. This is to prevent the accidental leakage to unauthorized users.

After signing up to Blimp, you need to generate a new API Key if you don't have one in your settings as well as an Application ID and Secret in your applications. You should only use your Application Secret key in server to server scenarios. Don't leak your secret key to your users. For client-side applications use your Application ID and domain from where the requests will be generated.

Using curl

$ curl https://app.getblimp.com/api/v2/company/ \
    -H "Authorization: ApiKey USERNAME:API_KEY" \
    -H "X_BLIMP_APPID: APPLICATION_ID" \
    -H "X_BLIMP_SECRET: APPLICATION_SECRET"

Using Python library

import blimp

api = blimp.Client('username', 'api_key', 'app_id', 'app_secret')

Using PHP library

require_once 'src/BlimpAPI.class.php';

$client = new Client($username, $api_key, $app_id, $app_secret);

Pagination

Requests that return multiple items will be paginated to 20 items by default. You can specify further pages with the limit and offset parameter.

$ curl https://app.getblimp.com/api/v2/task/?limit=1&offset=2

The pagination info is included in meta key when getting a list of objects.

It includes the following

limit : Shows the limit used that specified how many items to be shown.

offset : Shows the offset used that specified where to start displaying results from.

total_count : Shows the number of resources seen.

next : Shows a convenience link to the next available page of data as available.

prev : Shows a convenience link to the previous available page of data as available.

Rate Limiting

We limit requests to 300 per hour.

$ curl -i https://app.getblimp.com/api/v2/company/

HTTP/1.1 200 OK
Status: 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 134

Client Libraries

To submit a new client library send an email to support@getblimp.com

Resources