Add - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

reporterID

string | null

optional

assigneeID

string | null

optional

parentTaskID

string | 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

optional

Any of

ICommonTaskTimePair

number | null

estimated

number <double> | null

optional

actual

number <double> | null

optional

attachments

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

optional

title

string | null

optional

url

string | null

optional

status

enum<string>

required

Allowed values:

pendingstartedcompletedcancelled

projectID

string | null

optional

fileImportData

optional

Any of

IFileImportData

number | null

fileImportId

string

required

rowId

string

required

taskNumber

string | null

optional

Example

{
    "reporterID": "string",
    "assigneeID": "string",
    "parentTaskID": "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": {
        "estimated": 0,
        "actual": 0
    },
    "attachments": [
        {
            "title": "string",
            "url": "string"
        }
    ],
    "status": "pending",
    "projectID": "string",
    "fileImportData": {
        "fileImportId": "string",
        "rowId": "string"
    },
    "taskNumber": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/task' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reporterID": "string",
    "assigneeID": "string",
    "parentTaskID": "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": {
        "estimated": 0,
        "actual": 0
    },
    "attachments": [
        {
            "title": "string",
            "url": "string"
        }
    ],
    "status": "pending",
    "projectID": "string",
    "fileImportData": {
        "fileImportId": "string",
        "rowId": "string"
    },
    "taskNumber": "string"
}'

Responses

🟢200Ok

application/json

Body

data

object (TaskDocumentJSON)

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

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
    },
    "message": "string"
}

🟢200Success