››

ProProfs Project API for Developers

Introduction

The ProProfs Project Restful API allows you to access and download your data as well as develop applications. Responses are in JSON format but can be return in other formats such as CSV, JSON, and HTML by using a /format/csv parameter.

Please note that all resources are protected by an hourly throttle limit of 500 calls per resource.

To use the API simply use the example code below with your required resource. For example:

https://api.projectbubble.com/v2/RESOURCE

Authenticating

To authenticate you will need your API key from the My Account page and your domain. Once you have these you need to send them in the HTTP header as shown below.

For example:

curl -H "key:27838413e610417bd866352767fe322ca97d94c8" -H "domain: mydomain.projectbubble.com" https://api.projectbubble.com/v2/user

Pagination

Resources that return multiple records support LIMIT and OFFSET parameters, the default maximum LIMIT is 1000. This could be used to show a list of projects over multiple pages, the below example shows the third "page" of projects, i.e. records 31 to 40:

https://api.projectbubble.com/v2/projects?limit=10&offset=30

Versioning

The desired version of the API is required in every call via a URL parameter, e.g. /v2/projects. The current version of the API is V2. Prior versions of the API are not supported but documentation is available on request.

API Rules

We encourage developers to build their own applications for either adding to the service (e.g. iPhone apps), data reporting, or connecting with other services (e.g. Google Apps). However there are certain rules we would like developers to abide which protect the developer and us. Please see our API Rules page to read more on this.