Get - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

projectId

string

optional

parentTaskId

string

optional

reporterId

string

optional

assigneeId

string

optional

searchText

string

optional

priority

string

optional

fromDate

string <date-time>

optional

predefinedFilter

enum<string>

optional

Allowed values:

updated-todaycompleted-todaydue-todaydue-tomorrowdue-this-weekoverdueassigned-to-meurgent

toDate

string <date-time>

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

title

sortOrder

number <double>

optional

Default:

1

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/task?projectId&parentTaskId&reporterId&assigneeId&searchText&priority&fromDate&predefinedFilter&toDate' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (TaskDocumentJSON) {22}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organization

object (ICommonOrganization)

required

taskNumber

string | null

required

reporter

object | null

optional

assignee

object | null

optional

parentTask

object | null

optional

priority

number <double> | null

optional

labels

array[string] | null

optional

dueDate

string <date-time> | null

optional

startDate

string <date-time> | null

optional

endDate

string <date-time> | null

optional

title

string | null

required

summary

string | null

optional

sortOrder

number <double> | null

optional

time

object | null

optional

attachments

array[object (ICommonAttachments) {2}] | null

optional

status

enum<string>

required

Allowed values:

pendingstartedcompletedcancelled

project

optional

isDeleted

boolean

required

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "__v": 0,
            "_id": "string",
            "organization": {
                "id": "string",
                "organizationId": "string",
                "name": "string",
                "state": "string"
            },
            "taskNumber": "string",
            "reporter": {
                "type": "organization-admin",
                "email": "string",
                "name": "string",
                "id": "string"
            },
            "assignee": {
                "type": "organization-admin",
                "email": "string",
                "name": "string",
                "id": "string"
            },
            "parentTask": {
                "assignee": {
                    "type": "organization-admin",
                    "email": "string",
                    "name": "string",
                    "id": "string"
                },
                "title": "string",
                "taskNumber": "string",
                "id": "string"
            },
            "priority": 0,
            "labels": [
                "string"
            ],
            "dueDate": "2019-08-24T14:15:22Z",
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z",
            "title": "string",
            "summary": "string",
            "sortOrder": 0,
            "time": {
                "actual": 0,
                "estimated": 0
            },
            "attachments": [
                {
                    "title": "string",
                    "url": "string"
                }
            ],
            "status": "pending",
            "project": {
                "id": "string",
                "title": "string",
                "projectKey": "string"
            },
            "isDeleted": true
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success