Making API requests

The API reference documentation at https://developers.podio.com/doc lists all available API operations.

After you authenticated successfully you can start making API requests using the request method.

The method accepts the following parameters:

GET and DELETE requests

podio.request('GET', '/tasks', null, function(responseData) {
  // do something with the data  
});

POST and PUT requests

var requestData = { data: true };

podio.request('POST', '/tasks', requestData, function(responseData) {
  // response, if available
});

File uploads

For file uploads the uploadFile method can be used. It has the following signature:

Note: Uploading files is currently only supported in NodeJS and not in the browser.

Using promises

The request function returns a promise object which can be used instead of the callback function. The promise format used is EcmaScript 6 Promises. We recommend using the ES6-Promise library for pollyfilling older browsers.

Here is an example of using request with a promise:

podio.request('GET', '/tasks').then(function(responseData) {
   // response, if available
});

Error handling

Depending on the error code PlatformJS SDK will throw different exceptions. On all exceptions you will be able to access the following properties:

The following exceptions are possible:

Error body

A typical error body returned by the Platform API looks like this:

{
  "error_parameters": {},
  "error_detail": null,
  "error_propagate": false,
  "request": {
    "url": "http:\/\/api.podio.com\/comment\/item\/78077883\/",
    "query_string": "",
    "method": "POST"
  },
  "error_description": "No matching operation could be found. No body was given.",
  "error": "not_found"
}