Responses

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 zipBoard Tasks.

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 Responses

GEThttps://app.zipboard.co/api/v1/issues/responses/

To get the corresponding responses related to the tasks.
For responses to be visible, the user must be logged in and authenticated. If no user is logged in, the responses will not be visible.

HEADERS

Content-Type application/json

Authorization Authorization token

URL Params

Required:

None

Optional:

none

Body Prams

Required:

taskid: String taskid of the responses to fetch

Optional:

none

Request

var http = require('http'); 
Http.request({    
	method: 'GET',    
	url: `https://app.zipboard.co/api/v1/isssues/responses`,    
	body: {         
		tsakid:"9QPkEqjACxBcqhqL3"    
	},  
});

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Successfully retrieved responses.",
    "data": [
        {
            "_id": "qDMjhELEZtMtjAg9e",
            "created_at": "2020-02-17T07:53:36.808Z",
            "reply_text": "new feed",
            "task_id": "9QPkEqjACxBcqhqL3",
            "project_id": "3y55wtEkJqvN5AKD9",
            "screen_id": null,
            "user_id": "PLGMkdHJsgk5ZcFCY",
            "user_name": "Nippun"
        },
        {
            "_id": "EcRCF2EX5GwCQrnXs",
            "created_at": "2020-02-17T10:40:12.755Z",
            "reply_text": "testing reply",
            "task_id": "9QPkEqjACxBcqhqL3",
            "project_id": "3y55wtEkJqvN5AKD9",
            "user_id": "PLGMkdHJsgk5ZcFCY",
            "user_name": "Nippun"
        },
        {
            "_id": "Ro8ahvnYnGbTd5XZN",
            "created_at": "2020-02-18T04:14:36.531Z",
            "reply_text": "testing reply edit 34",
            "task_id": "9QPkEqjACxBcqhqL3",
            "project_id": "3y55wtEkJqvN5AKD9",
            "screen_id": -1,
            "user_id": "PLGMkdHJsgk5ZcFCY",
            "user_name": "Nippun"
        },
        {
            "_id": "8ZKdmR7A4epj47bJY",
            "created_at": "2020-02-18T09:25:18.082Z",
            "reply_text": "new reply fro api",
            "task_id": "9QPkEqjACxBcqhqL3",
            "project_id": "3y55wtEkJqvN5AKD9",
            "screen_id": -1,
            "user_id": "PLGMkdHJsgk5ZcFCY",
            "user_name": "Nippun"
        }
    ]
}

Create Rsponse

GEThttps://app.zipboard.co/api/v1/issues/responses/

Creates new response for the task, data required (title, projectid).
To add a response to the task, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘Reviewer’ in the project.
Returns the data of the newly created response.

HEADERS

Content-Type application/json

Authorization Authorization token

URL Params

Required:

None

Optional:

None

Body Prams

Required:

taskid String id of the project where task should be created

reply String Title of the task

Optional:

None

Request

var http = require('http'); 
Http.request({    
	method: 'POST',    
	url: `https://app.zipboard.co/api/v1/issues/tasks`,    
	body: {      
		taskid: "9QPkEqjACxBcqhqL3",             
		reply: "new reply from api"    
	},  
});

Response

 {
    "status": "Success",
    "status code": 201,
    "message": "New Task Created",
    "data": {
        "_id": "rmRLttbWNoNY8Fmj4",
        "created_at": "2020-02-18T10:06:53.776Z",
        "reply_text": "new reply from api",
        "task_id": "9QPkEqjACxBcqhqL3",
        "project_id": "3y55wtEkJqvN5AKD9",
        "screen_id": -1,
        "user_id": "PLGMkdHJsgk5ZcFCY",
        "user_name": "Nippun"
    }
}

Update Response

PUThttps://app.zipboard.co/api/v1/issues/responses/:id

Updates the existing response for the user, data required (reply).
To update the response, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘response owner’.
Returns the updated responsemessage.

HEADERS

Content-Type application/json

Authorization Authorization token

URL Params

Required:

id: String id of the response to be updated(string)

Body Prams

Required:

reply String task title

Optional:

none

Request

var http = require('http'); 
Http.request({    
	method: 'PUT',    
	url: `https://app.zipboard.co/api/v1/issues/responses/rmRLttbWNoNY8Fmj4
`,    
	body: {      
		reply: "task-003",          
	},  
});

Response

  {
    "status": "Success",
    "status code": 200,
    "message": "Response successfully updated.",
    "data": {
        "_id": "rmRLttbWNoNY8Fmj4",
        "created_at": "2020-02-18T10:06:53.776Z",
        "reply_text": "new reply from api updated",
        "task_id": "9QPkEqjACxBcqhqL3",
        "project_id": "3y55wtEkJqvN5AKD9",
        "screen_id": -1,
        "user_id": "PLGMkdHJsgk5ZcFCY",
        "user_name": "Nippun"
    }
}

Delete Response

PUThttps://app.zipboard.co/api/v1/issues/responses/:id

Deletes the existing response for the task
To delete a task, the role of the current user should be ‘Owner’ or ‘Manager’ or ‘task creator’.

HEADERS

Content-Type application/json

Authorization Authorization token

URL Params

Required:

none

Optional:

none

Request

var http = require('http'); 
Http.request({    
	method: 'DELETE',    
	url: `https://app.zipboard.co/api/v1/issues/responses/rmRLttbWNoNY8Fmj4`,  
});

Response

{
    "status": "Success",
    "status code": 200,
    "message": "Response successfully deleted"
}

If you have any questions, you can check out our Forum.