API for Organization

Welcome to the zipBoard platform REST API reference. This API is essential for connecting remotely with zipBoard, regardless of whether you are building an application, scripting interactions with zipBoard or building some other integration. 

This page documents the REST resources available in the zipBoard platform, along with the expected HTTP response codes and sample requests for interacting with projects in zipBoard.

Before you start working with the API, you will need to generate an API key and also get an idea of the URI Structure that needs to be followed. Please follow this article for more information on that.

Get Organisation

GET https://app.zipboard.co/api/v1/orgs

• Returns the organization id and name where the user is owner and manager..
• For organization to be visible, the user must be logged in and authenticated. If no user is logged in, then the organization data will not be visible.

HEADERS

Content-Type                  application/json

Authorization                  Authorization token

URL Params        

Required:

None

     Optional:

None

Request

var http=require('http');
Http.request({
  method: 'GET',
  url: `https: //app.zipboard.co/api/v1/orgs`,
  body: { },
});

Response

 {
    "status": "Success",
    "status code": 200,
    "message": "Succesfully retrieved Orgs.",
    "data": [
        {
            "id": "bmifEBw8CMH99Wzsd",
            "name": "Qwerty's Organization"
        }
    ]
}