Quire API API Reference

Introduction

Welcome to the reference for the Quire REST API!

The Quire REST API provides a broad set of operations and resources that:

  • Consistently do repetitive or tedious tasks.
  • Chain a process together for your team’s process and workflow.
    • Pull information from other locations such as email and Evernote into Quire.
    • Push information from Quire to other locations such as email and Zapier.

Want to share your thoughts on how Quire API works for you? Tell us how you feel about using our API and what we can do to make it better.

REST is a web-service protocol for rapid development by using HTTP and JSON technology.

API Changelog

You can find the Changelog of the API Reference in the Quire Community.

Authentication

OAuth v2.0

Quire uses OAuth v2.0 to authenticate your app to access the Quire REST API on behalf of users without getting their password.

Authenticating via OAuth2 requires the following steps:

  1. Register Your Application on Quire
  2. Ask a Quire User to Grant Access to Your Application
  3. Retrieve an Access Token
  4. Make Authenticated Requests

Register Your Application on Quire

Quire API

1. Give your app a cool name

Your app deserves a cool name that lives up to its wide broad of great features.

All of the app users will see this name in public, so think carefully!

2. Choose the Quire Organization that your app belongs to

You can choose an organization in Quire that your app belongs to.

If one day you decide to leave the organization, you will lose the authority to manage the app.

3. Redirect URL

When users grant your app authorization request, users will be directed to the configured URL that you’ve set.

4. Choose permission scopes

You can set permission on what your app can do with Quire. There are several options for you to choose from.

Note: If none of the options is selected, the app can only read user’s data.

5. Development Client ID and Client Secret

Quire Open API

The Client ID and Client secret will be automatically generated as you create an app.

The Client ID is a unique ID to identify your app.

You should keep your client secret safe, which means you should never share your client secret with anyone. If you choose to regenerate the client secret, the old one will immediately become invalid.

6. Update your App

If your app hasn't been published to Quire App Directory, it will remain as unpublished status. You can still use the configured shareable link in the Developer App Console Distribution to share the app with other users for testing or integration.

When you make changes to the app, you can use the shareable link to access the development copy as well. Working on your development copy will not affect your live App Directory app. When your updated app is ready to be published and replaced the old version on Quire App Directory, your published app will have a different Client ID to the unpublished one.

There are two sets of Client ID and Client Secret.

  • Development set - should be used during developing and testing internally of the app.
  • Production set - should be used once your app is ready and published on Quire App Directory.

Fulfill Authorization Request

Ask a Quire User to Grant Access to Your Application

Once registering your application, you can ask your user to grant access to your application.

The authorization endpoint lets users grant your app access to the requested permissions.

The authorization endpoint should look like this:

https://quire.io/oauth?client_id=your-client-ID&redirect_uri=your-redirect-uri

Quire Grant Access

After your user clicks Allow, the access will be granted, and he will be redirected to the URL you specified in the redirect_uri parameter with an authorization code provided as a query parameter called code.

After your app is granted, you can have an authorization code to exchange access token for access Quire API. The redirect_uri is optional. If not being specified, we will automatically use the one that is previously detected in the app. If specified, the redirect URL must start with the prefix of the one that was previously detected in the app.

Parameter Value
client_id {your-client-ID}
redirect_uri Optional. The redirect URL after granted. If specified, it must match the redirect URL specified in your app's config. Otherwise, the configured URL will be used.
state Optional. A random string generated by your app to protect from XSRF.

Retrieve Access Token

To retrieve the access token, you have to post a request to https://quire.io/oauth/token with the following data:

Parameter Value
grant_type authorization_code
code {your-authorization-code}
client_id {your-client-ID}
client_secret {your-client-secret}

Then, the access token will be returned in the response's body.

{
  "access_token":"ACCESS_TOKEN",
  "token_type": "bearer",
  "expires_in":2592000,
  "refresh_token":"REFRESH_TOKEN"
}

The token should be kept carefully and permanently since you need it to access every Quire API.

Use Access Token to Access Quire API

In each request, the access token must be put in the header. The header name is Authorization and the value is Bearer your_token.

After you exchange the access token, your app can make requests to Quire API on behalf of the authorized users.

curl -H 'Authorization: Bearer {access_token}' \
https://quire.io/api/user/id/me
{
  "email": "john@gmail.cc",
  "website": "https://coolwebsites.com",
  "id": "My_ID",
  "description": "This is *cool*!",
  "url": "https://quire.io/u/My_ID",
  "nameText": "My Name",
  "nameHtml": "My Name",
  "descriptionText": "This is cool!",
  "descriptionHtml": "This is <i>cool</i>!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "name": "My Name",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

Token Expiration

A refresh token might stop working for one of these reasons:

  • The user has revoked your app's access.
  • The refresh token has not been used for 6 months.

Publish App

Quire Publish App

By default, your app will be set as Private. You can change the app distribution to Public so that other Quire users can install your app to their workspace as well.

If your app is made available on Quire App Directory and you want to delete the app, you should communicate with your users first before depreciating the app.

WebHook

When one event on Quire is triggered, the system will send a payload to the webhook's configured URL.

A webhook is used by Quire to call an app, while Quire API is used by an app to call Quire. To receive these events, you have to specify a valid URL for Webhooks when configuring your app.

System Events

A system event is used to notify your app about system or app's activities.

Token Expiration

When the token has been expired or revoked, an event will be sent to your app. You can clean up your storage if necessary.

{
  "type": "system",
  "token": "hook-token-defined-by-you",
  "secret": "secret-defined-by-you",
  "data": {
    "type": "token-revocation",
    "token": "the-refresh-token"
  }
}

Notification Events

A notification is the information about a update (aka., an activity). Here is an example:

{
  "type": "notification",
  "token": "hook-token-defined-by-you",
  "secret": "secret-defined-by-you",
  "data": {
    "type": 0, //activity's type
    "when": "2019-09-30T08:20:12.000Z",
    "what": {
      "oid": "YxjapXXRCOYxoaiCT4tT3OQm", //OID of a task, project, or organization depending on type
      "id": 101,
      "name": "Brand new start"
    },
    "user": {
      "oid": "1AbDEFed2A5031BEDDweqmde", //OID of the user
      "id": "john.doer",
      "name": "John Doer"
    },
    "message": "<a href=\"https://quire.io/u/john.doer\">John Doer</a> added <a href=\"https://quire.io/w/MyProjects/101\">Brand new start</a>",
    "text": "John Doer added Brand new start",
    "url": "https://quire.io/w/MyProjects/101"
  } 
}

There is an optional field called value in the map of the data field. It carries the detailed information in a map instance. For example, it carries the assignee's ID, name and URL if it is an assignment. Also, if the notification is about start or due, there will be another field called due in the map of the data field. It is the date time formatted in user's locale and time zone.

Registration for notifications

If the app wants to receive notifications of a specific projects or tasks, it can follow the projects or apps by sending a PUT request to the URL. To add a follower, the body of the request can be:

{
  "addFollowers": ["app"]
}

Where app is a keyword. It indicates that the app would like to add to its followers.

In additions, you can specify additional information that will be passed as part of a notification int the following syntax.

Syntax 1

"app|team|channel"

where app is a keyword while team and channel are application specific. That is, you can pass any value to team and channel. For example,

{
  "addFollowers": ["app|extra101"]
}

Then, the notification will carry additional field called team with the value "extra101":

{
  "type": "notification",
  "team": "extra101",
  "data": {
    //refer the Notifications section for details
  }
}

Another example:

{
  "addFollowers": ["app|extra101|channel9"]
}

You'll get:

{
  "type": "notification",
  "team": "extra101",
  "channel": "channel9",
  "data": {
    //refer the Notifications section for details
  }
}

Syntax 2

"app|/path"

where app is a keyword, and /path is application specific. The path will be appended to the app's hook URL. For example, assume the app's hook URL is "https://super.app/hooks/standard", and the follower "app|/soc/id279/channel51". Then, the notification will be posted the following URL: "https://super.app/hooks/standard/soc/id279/channel51".

If you'd like to pass additional information in this syntax, you can append it as follows.

"app|/path|channel"

For example, app|/soc/id8|box51. Then, box51 will be part of the JON object sent to the hook URL.

{
  "type": "notification"
  "channel": "box51"
  "data": {
    //refer the Notifications section for details
  }
}

Rate limits

To protect the stability of the API and keep it available to all users, Quire enforces multiple kinds of rate limiting. Requests that hit any of our rate limits will receive a 429 Too Many Requests response. We may change these quotas or add new quotas in the future.

Here are the limits for free plans.

Plan Maximum requests per organization, per minute Maximum requests per organization, per hour
Free 25 120

Note: the limit is per-organization. It sums up the total number of all accesses from all applications for each organization. For more quota, please refer to Pricing.

Size limits

The size of each request can't be larger than 2MB. Requests that hit this limit will receive a 413 Payload too large response.

Status codes

Code Meaning Description
200 Success Request successful
400 Bad Request You're using a wrong parameter, or passing incorrect data.
401 Unauthorized Invalid or expired token.
403 Forbidden Not authorized to access the resource.
404 Not Found The specified resource could not be found.
405 Method not Allowed Method not allowed or supported.
409 Conflict There is already a resource with the same criteria.
429 Too Many Requests Exceeded the rate limit for API calls
500 Internal Server Error There is an unexpected error.
503 Service Unavailable Server is down for maintenance.

Error responses

The following JSON data is returned in the response body when an error occurs.

{
    "code": a_number,
  "message": "an error message here"
}
Error Code Meaning
100 General authentication error.
400 Bad request including wrong request body, wrong parameter and so on.
401 Invalid or expired token.
403 Forbidden.
404 Resource not found.
405 Method not allowed.
413 Request too large.
429 Too many invocations.
469 Quota exceeded, such as number of projects and number of members.
500 General invocation error. Most likely, an internal error.
API Endpoint
https://quire.io/api
Terms of Service: https://quire.io/terms
Contact: info@quire.io
Schemes: https
Version: 1.0.0

comment

A comment that an user can put to a task or project.

Add a new comment to a project.

POST /comment/id/{projectId}

Add a new comment to a project.

projectId: string
in path

ID of the project that new comment will be added to

description: string

The content of the new comment.

asUser: boolean

(Optional) Specify true if you'd like to make this new comment as created by the app. Default: false -- the comment is marked as created by the user authorizing the app.

pinned: boolean

(Optional) Whether to pin this comment. Default: false

Request Example
{
  "description": "Adjust style",
  "asUser": true,
  "pinned": false
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new comment to a task.

POST /comment/id/{projectId}/{taskId}

Add a new comment to a task.

projectId: string
in path

ID of the project that the task is in

taskId: integer
in path

ID of the task that new comment will be added to

description: string

The content of the new comment.

asUser: boolean

(Optional) Specify true if you'd like to make this new comment as created by the app. Default: false -- the comment is marked as created by the user authorizing the app.

pinned: boolean

(Optional) Whether to pin this comment. Default: false

Request Example
{
  "description": "Adjust style",
  "asUser": true,
  "pinned": false
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new comment to a task or a project.

POST /comment/{oid}

Add a new comment to a task or a project. If the given OID is a project, the comment will be added to a project. If a task, the comment will be added to a task.

oid: string
in path

OID of the project or task that new comment will be added to

description: string

The content of the new comment.

asUser: boolean

(Optional) Specify true if you'd like to make this new comment as created by the app. Default: false -- the comment is marked as created by the user authorizing the app.

pinned: boolean

(Optional) Whether to pin this comment. Default: false

Request Example
{
  "description": "Adjust style",
  "asUser": true,
  "pinned": false
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get a comment with project's OID

GET /comment/{projectOid}/{oid}

Returns the full comment record of the given OID.

projectOid: string
in path

OID of the project that the comment is in.

oid: string
in path

OID of comment that needs to be feteched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get a comment with project's ID

GET /comment/id/{projectId}/{oid}

Returns the full comment record of the given OID.

projectId: string
in path

ID of the project that the comment is in.

oid: string
in path

OID of comment that needs to be feteched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all comments of the given project.

GET /comment/list/id/{projectId}

Returns all comment records of the given project by its ID.

projectId: string
in path

ID of project.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "iDsPd.QP_qM.hN.Trymukn8b",
    "description": "It is *cool*!",
    "descriptionHtml": "It is <i>cool</i>!",
    "descriptionText": "It is cool!",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": {
          "url": "https://quire.io/u/my_id",
          "id": "my_id",
          "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
          "iconColor": "37",
          "name": "Foo",
          "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
        },
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "url": "string",
    "pinBy": "#/definitions/SimpleIdentity",
    "pinAt": "2018-12-22T02:06:58.158Z",
    "editedBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "owner": {
      "url": "https://quire.io/u/my_id",
      "type": "Project",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all comments of the given task.

GET /comment/list/id/{projectId}/{taskId}

Returns all comment records of the given task by its ID.

projectId: string
in path

ID of the project.

taskId: integer
in path

ID of the task

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "iDsPd.QP_qM.hN.Trymukn8b",
    "description": "It is *cool*!",
    "descriptionHtml": "It is <i>cool</i>!",
    "descriptionText": "It is cool!",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": {
          "url": "https://quire.io/u/my_id",
          "id": "my_id",
          "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
          "iconColor": "37",
          "name": "Foo",
          "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
        },
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "url": "string",
    "pinBy": "#/definitions/SimpleIdentity",
    "pinAt": "2018-12-22T02:06:58.158Z",
    "editedBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "owner": {
      "url": "https://quire.io/u/my_id",
      "type": "Project",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get comments added to the given object.

GET /comment/list/{oid}

Returns all comment records of the given object that can be a project or a task.

oid: string
in path

OID of project or task that comments will be be fetched from.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "iDsPd.QP_qM.hN.Trymukn8b",
    "description": "It is *cool*!",
    "descriptionHtml": "It is <i>cool</i>!",
    "descriptionText": "It is cool!",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": {
          "url": "https://quire.io/u/my_id",
          "id": "my_id",
          "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
          "iconColor": "37",
          "name": "Foo",
          "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
        },
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "url": "string",
    "pinBy": "#/definitions/SimpleIdentity",
    "pinAt": "2018-12-22T02:06:58.158Z",
    "editedBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "owner": {
      "url": "https://quire.io/u/my_id",
      "type": "Project",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Update an existing comment with project's OID

PUT /comment/{projectOid}/{oid}

Updates an existing comment, and returns the complete updated comment record.

projectOid: string
in path

OID of the project that the comment is in.

oid: string
in path

OID of the comment that needs to be updated.

description: string

(Optional) The new content of the comment.

pinned: boolean

(Optional) Whether to pin this comment.

Request Example
{
  "description": "Adjust style",
  "pinned": false
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Update an existing comment with project's ID

PUT /comment/id/{projectId}/{oid}

Updates an existing comment, and returns the complete updated comment record.

projectId: string
in path

ID of the project that the comment is in.

oid: string
in path

OID of the comment that needs to be updated.

description: string

(Optional) The new content of the comment.

pinned: boolean

(Optional) Whether to pin this comment.

Request Example
{
  "description": "Adjust style",
  "pinned": false
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Delete an existing comment with project's OID

DELETE /comment/{projectOid}/{oid}

Delete an existing comment.

projectOid: string
in path

OID of the project that the comment is in.

oid: string
in path

OID of comment that needs to be deleted

200 OK

ok

Response Content-Types: application/json

Delete an existing comment with project's ID

DELETE /comment/id/{projectId}/{oid}

Delete an existing comment.

projectId: string
in path

ID of the project that the comment is in.

oid: string
in path

OID of comment that needs to be deleted

200 OK

ok

Response Content-Types: application/json

notification

Sends a notification the user who granted the access. It is usually to report an error to the user.

Send a notification.

POST /notification

Send a notification to the user.

url: string

(Optional) The URL of the message.If not omitted, a hyperlink will be generated to enclose the message.

message: string

The message

Request Example
{
  "url": "https://superheros.com/sync",
  "message": "Unable to synchronize"
}
200 OK

ok

Response Content-Types: application/json

organization

An organization is a group of projects where members collaborate at once.

Get an organization by its ID.

GET /organization/id/{id}

Returns the complete organization record of the given OID.

id: string
in path

ID of organization that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/c/my_organization",
  "name": "My Organization",
  "id": "my_organization",
  "email": "info@compony.com",
  "nameHtml": "My Organization",
  "nameText": "My Organization",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdBy": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get an organization by its OID.

GET /organization/{oid}

returns the complete organization record.

oid: string
in path

OID of organization that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/c/my_organization",
  "name": "My Organization",
  "id": "my_organization",
  "email": "info@compony.com",
  "nameHtml": "My Organization",
  "nameText": "My Organization",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdBy": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all organizations.

GET /organization/list

Returns the organization records for all organizations that the current user can grant to this application.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/c/my_organization",
    "name": "My Organization",
    "id": "my_organization",
    "email": "info@compony.com",
    "nameHtml": "My Organization",
    "nameText": "My Organization",
    "website": "https://coolwebsites.com",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "createdBy": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

partner

An external team (aka., a parnter) is a group of users that can access only tasks that are assigned to this team.

Get an external team (aka., a partner).

GET /partner/{oid}

Returns the full external team record of the given OID.

oid: string
in path

OID of external team that needs to be fetched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "UI design team",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all external teams of the given project by its ID.

GET /partner/list/id/{projectId}

Returns all external team records of the given project by its ID.

projectId: string
in path

ID of project to look for

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "UI design team",
    "color": "35",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "project": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all external teams of the given project by its OID.

GET /partner/list/{projectOid}

Returns all external team records of the given project by its OID.

projectOid: string
in path

OID of the project to look for

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "UI design team",
    "color": "35",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "project": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

project

A project represents a prioritized list of tasks in Quire. It exists in a single organization and is accessible to a subset of users in that organization, depending on its permissions.

Get a project by its ID.

GET /project/id/{id}

Returns the complete project record of the given ID.

id: string
in path

ID of project that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "organization": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "url": "https://quire.io/w/my_project",
  "name": "My Project",
  "id": "my_project",
  "activeCount": 20,
  "taskCount": 30,
  "nameHtml": "My Project",
  "nameText": "My Project",
  "rootCount": 5,
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "archivedAt": "2018-12-22T02:06:58.158Z",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get a project by its OID.

GET /project/{oid}

Returns the complete project record of the given OID.

oid: string
in path

OID of project that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "organization": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "url": "https://quire.io/w/my_project",
  "name": "My Project",
  "id": "my_project",
  "activeCount": 20,
  "taskCount": 30,
  "nameHtml": "My Project",
  "nameText": "My Project",
  "rootCount": 5,
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "archivedAt": "2018-12-22T02:06:58.158Z",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all granted projects.

GET /project/list

Returns the project records for all projects that the current user can grant to this application.

archived: boolean
in query

Whether to return archived projects. By default, archived projects won't be returned. If the parameter is specified without value, true is assumed.

add-task: boolean
in query

Whether to return only projects that you can add tasks to. Default: false. If the parameter is specified without value, true is assumed.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "organization": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "url": "https://quire.io/w/my_project",
    "name": "My Project",
    "id": "my_project",
    "activeCount": 20,
    "taskCount": 30,
    "nameHtml": "My Project",
    "nameText": "My Project",
    "rootCount": 5,
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "archivedAt": "2018-12-22T02:06:58.158Z",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all granted projects of the organization by its ID.

GET /project/list/id/{organizationId}

Returns all project records of the given organization. Only granted projects will be returned.

organizationId: string
in path

ID of the organization

archived: boolean
in query

Whether to return archived projects. By default, archived projects won't be returned. If the parameter is specified without value, true is assumed.

add-task: boolean
in query

Whether to return only projects that you can add tasks to. Default: false. If the parameter is specified without value, true is assumed.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "organization": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "url": "https://quire.io/w/my_project",
    "name": "My Project",
    "id": "my_project",
    "activeCount": 20,
    "taskCount": 30,
    "nameHtml": "My Project",
    "nameText": "My Project",
    "rootCount": 5,
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "archivedAt": "2018-12-22T02:06:58.158Z",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all granted projects of the organization by its OID.

GET /project/list/{organizationOid}

Returns all project records of the given organization. Only granted projects will be returned.

organizationOid: string
in path

OID of the organization.

archived: boolean
in query

Whether to return archived projects. By default, archived projects won't be returned. If the parameter is specified without value, true is assumed.

add-task: boolean
in query

Whether to return only projects that you can add tasks to. Default: false. If the parameter is specified without value, true is assumed.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "organization": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "url": "https://quire.io/w/my_project",
    "name": "My Project",
    "id": "my_project",
    "activeCount": 20,
    "taskCount": 30,
    "nameHtml": "My Project",
    "nameText": "My Project",
    "rootCount": 5,
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "archivedAt": "2018-12-22T02:06:58.158Z",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Update a project.

PUT /project/{oid}

Updates an existing project, and returns the complete updated project record.

oid: string
in path

OID of project that needs to be updated

followers: string[]

(Optional) OID of the users to replace the followers of this project. Please refer to addFollowers() for more details.

addFollowers: string[]

(Optional) OID of the followers to be added to this project.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

removeFollowers: string[]

(Optional) OID of the followers to be removed from this project. Please refer to addFollowers() for more details.

Request Example
{
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl",
    "app"
  ],
  "addFollowers": [
    "sfsvLbDVPvi1QMf2GkDn7VSy"
  ],
  "removeFollowers": [
    "aBuz4MwfZ5CasOae6stnFa2f"
  ]
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "organization": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "url": "https://quire.io/w/my_project",
  "name": "My Project",
  "id": "my_project",
  "activeCount": 20,
  "taskCount": 30,
  "nameHtml": "My Project",
  "nameText": "My Project",
  "rootCount": 5,
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "archivedAt": "2018-12-22T02:06:58.158Z",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

status

A task status is a value to indicate the progress of a task.

Add a new task status.

POST /status/{projectOid}

Add a new task status into a project.

projectOid: string
in path

OID of project that this new task status to be added to.

name: string

The name of the status

value: integer

The value. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.If not omitted, a color will be generated automatially.

Request Example
{
  "name": "Doing",
  "value": "true",
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Add a new task status.

POST /status/id/{projectId}

Add a new task status into a project.

projectId: string
in path

ID of project that this new task status to be added to.

name: string

The name of the status

value: integer

The value. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.If not omitted, a color will be generated automatially.

Request Example
{
  "name": "Doing",
  "value": "true",
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Get the task status of the given value.

GET /status/{projectOid}/{value}

Returns the full status record of the given value.

projectOid: string
in path

OID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be fetched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Get the task status of the given value.

GET /status/id/{projectId}/{value}

Returns the full status record of the given value.

projectId: string
in path

ID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be fetched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Get all statuses of the given project by its ID.

GET /status/list/id/{projectId}

Returns all status records of the given project by its ID.

projectId: string
in path

ID of project.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "Doing",
    "value": 50,
    "color": "35"
  }
]

Get all statuses of the given project by its OID.

GET /status/list/{projectOid}

Returns all status records of the given project by its OID.

projectOid: string
in path

OID of the project.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "name": "Doing",
    "value": 50,
    "color": "35"
  }
]

Update a status.

PUT /status/{projectOid}/{value}

Updates an existing status, and returns the complete updated record.

projectOid: string
in path

OID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be updated.

name: string

(Optional) The new name of the status.

value: integer

(Optional) The new value of the status. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.

Request Example
{
  "name": "Later",
  "value": "true",
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Update a status.

PUT /status/id/{projectId}/{value}

Updates an existing status, and returns the complete updated record.

projectId: string
in path

ID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be updated.

name: string

(Optional) The new name of the status.

value: integer

(Optional) The new value of the status. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.

Request Example
{
  "name": "Later",
  "value": "true",
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

Delete a status

DELETE /status/{projectOid}/{value}

Delete an existing status.

projectOid: string
in path

OID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be deleted.

200 OK

ok

Response Content-Types: application/json

Delete a status

DELETE /status/id/{projectId}/{value}

Delete an existing status.

projectId: string
in path

ID of project that the task status belongs to.

value: integer
in path

The status's value that needs to be deleted.

200 OK

ok

Response Content-Types: application/json

storage

A storage to store application specific data. The application specific data is stored per access token. They will be deleted if the token is revoked or expired.

Get the application specific data of the given name.

GET /storage/{name}

Returns the application specific data of the given name, or null if not found. Note: application specific data are stored per access token.

name: string
in path

The name. Example: "latest"

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "myKey": "My data"
}

Get all stored application specific values with the given prefix.

GET /storage/list/{prefix}

Returns all stored application specific values that start with the given prefix. Note: at most 20 items are returned for each query.

prefix: string
in path

A prefix (optional). Example: "foo".If not specified, all values are returned.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "currentProject": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "latest": {
    "myKey": "My data"
  },
  "myList": [
    "string"
  ]
}

Update the application specific data of the given name.

PUT /storage/{name}

Updates the application specific data of the given name. If it doesn't exist, it adds the name to the given value. If the value is null, it is the same as deletion. It returns true if the value is updated or added successfully. Note: application specific data are stored per access token.

name: string
in path

The name. Example: "latest"

myKey: string

Property name

Request Example
{
  "myKey": "My data"
}
200 OK

ok

Response Content-Types: application/json

Delete the application specific data of the given name

DELETE /storage/{name}

Delete the application specific data of the given name. It returns true if the value is deleted successfully, or false if the name doesn't exist. Note: application specific data are stored per access token.

name: string
in path

The name. Example: "latest"

200 OK

ok

Response Content-Types: application/json

sublist

A sublist is a collections of tasks. It represents a subset of all tasks.

Add a new sublist.

POST /sublist/{projectOid}

Add a new sublist into a project.

projectOid: string
in path

OID of project that this new sublist to be added to.

description: string

(Optional) An optional description about this task.

name: string

The name of the sublist.

id: string

(Optional) ID of the sublist. If omitted, Quire will generate one automatically. It must be unquie in the whole project if specified

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

tasks: string[]

(Optional) A list of tasks' OID that belong to this sublist. Note: all of descendants will be included too.

iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

partner: string

(Optional) OID of the external team that this sublist belongs to.

personal: boolean

(Optional) Whether it is personal. If omitted, false is assumed.

due: string

(Optional) When this sublist was aimed to complete.

Request Example
{
  "description": "**Great** sublist to start with.",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "tasks": [
    "string"
  ],
  "iconColor": "37",
  "partner": "rcBHBYXZSiyDRrHrWPutatfF",
  "personal": "boolean",
  "due": "2020-01-22T02:06:58.158Z"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new sublist.

POST /sublist/id/{projectId}

Add a new sublist into a project.

projectId: string
in path

ID of project that this new sublist to be added to.

description: string

(Optional) An optional description about this task.

name: string

The name of the sublist.

id: string

(Optional) ID of the sublist. If omitted, Quire will generate one automatically. It must be unquie in the whole project if specified

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

tasks: string[]

(Optional) A list of tasks' OID that belong to this sublist. Note: all of descendants will be included too.

iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

partner: string

(Optional) OID of the external team that this sublist belongs to.

personal: boolean

(Optional) Whether it is personal. If omitted, false is assumed.

due: string

(Optional) When this sublist was aimed to complete.

Request Example
{
  "description": "**Great** sublist to start with.",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "tasks": [
    "string"
  ],
  "iconColor": "37",
  "partner": "rcBHBYXZSiyDRrHrWPutatfF",
  "personal": "boolean",
  "due": "2020-01-22T02:06:58.158Z"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get an existing sublist by its ID.

GET /sublist/id/{projectId}/{id}

Returns the full sublist record of the given ID.

projectId: integer
in path

ID of the project that the sublist belongs to.

id: string
in path

ID of the sublist that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get an existing sublist by its OID

GET /sublist/{oid}

Returns the full sublist record of the given OID.

oid: string
in path

OID of sublist that needs to be fetched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all sublists of the given project by its ID.

GET /sublist/list/id/{projectId}

Returns all sublist records of the given project by its ID.

projectId: string
in path

ID of project.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/w/my_project?sublist=Sublist101",
    "name": "Sublist 101",
    "id": "Sublist101",
    "nameHtml": "Sublist 101",
    "nameText": "Sublist 101",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "partner": {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "due": "2020-01-22T02:06:58.158Z",
    "archivedAt": "2020-02-22T02:06:58.158Z",
    "owner": {
      "url": "https://quire.io/u/my_id",
      "type": "Project",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all sublists of the given project by its OID.

GET /sublist/list/{projectOid}

Returns all sublist records of the given project by its OID.

projectOid: string
in path

OID of the project.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/w/my_project?sublist=Sublist101",
    "name": "Sublist 101",
    "id": "Sublist101",
    "nameHtml": "Sublist 101",
    "nameText": "Sublist 101",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "partner": {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "due": "2020-01-22T02:06:58.158Z",
    "archivedAt": "2020-02-22T02:06:58.158Z",
    "owner": {
      "url": "https://quire.io/u/my_id",
      "type": "Project",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Update a sublist by its ID.

PUT /sublist/id/{projectId}/{id}

Updates an existing sublist, and returns the complete updated record.

projectId: integer
in path

ID of the project that the sublist belongs to.

id: string
in path

ID of the sublist that needs to be fetched

description: string

(Optional) An optional description about this task.

due: string

(Optional) When this sublist was aimed to complete.

name: string

(Optional) The name of the sublist.

id: string

(Optional) ID of the sublist.

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

changes: Change

(Optional) A list of changes to control what tasks to be added to or removed from this sublist.

archived: boolean

(Optional) Specify true to archive this sublist. Or, specify false to undo the previous archiving if any.

Request Example
{
  "description": "**Great** sublist to start with.",
  "due": "2020-01-22T02:06:58.158Z",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "iconColor": "37",
  "changes": [
    {
      "task": "2MmYOpJH_ZLeehIjjytH1Rwr",
      "exclude": false,
      "single": false
    }
  ],
  "archived": true
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Update a sublist.

PUT /sublist/{oid}

Updates an existing sublist, and returns the complete updated record.

oid: string
in path

OID of sublist that needs to be updated

description: string

(Optional) An optional description about this task.

due: string

(Optional) When this sublist was aimed to complete.

name: string

(Optional) The name of the sublist.

id: string

(Optional) ID of the sublist.

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

changes: Change

(Optional) A list of changes to control what tasks to be added to or removed from this sublist.

archived: boolean

(Optional) Specify true to archive this sublist. Or, specify false to undo the previous archiving if any.

Request Example
{
  "description": "**Great** sublist to start with.",
  "due": "2020-01-22T02:06:58.158Z",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "iconColor": "37",
  "changes": [
    {
      "task": "2MmYOpJH_ZLeehIjjytH1Rwr",
      "exclude": false,
      "single": false
    }
  ],
  "archived": true
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Delete a sublist by its ID

DELETE /sublist/id/{projectId}/{id}

Delete an existing sublist of the given OID.

projectId: integer
in path

ID of the project that the sublist belongs to.

id: string
in path

ID of the sublist that needs to be fetched

200 OK

ok

Response Content-Types: application/json

Delete a sublist

DELETE /sublist/{oid}

Delete an existing sublist of the given OID.

oid: string
in path

OID of sublist that needs to be deleted

200 OK

ok

Response Content-Types: application/json

tag

A tag is a label that can be attached to any task in Quire.

tag

Add a new tag.

POST /tag/{projectOid}

Add a new tag into a project.

projectOid: string
in path

OID of project that this new tag to be added to. Specify "-" if you'd like to add it to the personal tasks that belong to no specific projects in My Tasks.

name: string

The name of the tag

global: boolean

(Optional) Whether this tag is global. If omitted, it is not glboal.

color: string

(Optional) The color of the tag.If not omitted, a color will be generated automatially.

Request Example
{
  "name": "Later",
  "global": true,
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "global": true,
  "name": "Later",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}
tag

Add a new tag.

POST /tag/id/{projectId}

Add a new tag into a project.

projectId: string
in path

ID of project that this new tag to be added to. Specify "-" if you'd like to add it to the personal tasks that belong to no specific projects in My Tasks.

name: string

The name of the tag

global: boolean

(Optional) Whether this tag is global. If omitted, it is not glboal.

color: string

(Optional) The color of the tag.If not omitted, a color will be generated automatially.

Request Example
{
  "name": "Later",
  "global": true,
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "global": true,
  "name": "Later",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}
tag

Get a tag.

GET /tag/{oid}

Returns the full tag record of the given OID.

oid: string
in path

OID of tag that needs to be fetched.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "global": true,
  "name": "Later",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}
tag

Get all tags of the given project by its ID.

GET /tag/list/id/{projectId}

Returns all tag records of the given project by its ID.

projectId: string
in path

ID of project. Specify "-" if you'd like to retrieve tags from the personal tasks that belong to no specific projects in My Tasks.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "global": true,
    "name": "Later",
    "color": "35",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "project": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]
tag

Get all tags of the given project by its OID.

GET /tag/list/{projectOid}

Returns all tag records of the given project by its OID.

projectOid: string
in path

OID of the project. Specify "-" if you'd like to retrieve tags from the personal tasks that belong to no specific projects in My Tasks.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "global": true,
    "name": "Later",
    "color": "35",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "project": {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]
tag

Update a tag.

PUT /tag/{oid}

Updates an existing tag, and returns the complete updated record.

oid: string
in path

OID of tag that needs to be updated

name: string

(Optional) The new name of the tag.

global: boolean

(Optional) Whether this tag is global. If you specify false here, you have to specify "project" for what project you'd like to put the tag to.

project: string

(Optional) OID of the project this tag shall be limited to. It is used only if "global" is also specified and false. Otherwise, it is simply ignored.

color: string

(Optional) The color of the tag.

Request Example
{
  "name": "Later",
  "global": true,
  "project": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "color": "35"
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "global": true,
  "name": "Later",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}
tag

Delete a tag

DELETE /tag/{oid}

Delete an existing tag of the given OID.

oid: string
in path

OID of tag that needs to be deleted

200 OK

ok

Response Content-Types: application/json

task

The task is a piece of work to be done or undertaken. It is the basic object that you and your team can collaborate on.

Add a new task.

POST /task/id/{projectId}

Add a new task into a project.

projectId: string
in path

ID of project that this new task to be added to. The new task will be added as a root task. Specify "-" if you'd like to add it to the personal tasks that belong to no specific projects in My Tasks.

description: string

(Optional) An optional description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks, if any.Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting). Default: false.

asUser: boolean

(Optional) Specify true if you'd like to make this new task as created by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of users who follow this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

assignees: string[]

(Optional) OID, ID or emails of the users that this task is assigned to.

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

name: string

The name of the task.

tags: string[]

(Optional) OID or names of the tags to be added to the new created task. Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) An optional priority. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

(Optional) An optional status. Its value must be between 0 and 100. Default: 0.

Request Example
{
  "description": "This is a *cool* task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "name": "Design new **logo**",
  "tags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "priority": 0,
  "status": 0
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new task.

POST /task/{oid}

Add a new task into a project or a task.

oid: string
in path

OID of project or task that this new task to be added to. If the given OID is a project, the new task will be added as a root task. If the given OID is a task, the new task will become its subtask. Specify "-" if you'd like to add it to the personal tasks that belong to no specific projects in My Tasks.

description: string

(Optional) An optional description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks, if any.Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting). Default: false.

asUser: boolean

(Optional) Specify true if you'd like to make this new task as created by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of users who follow this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

assignees: string[]

(Optional) OID, ID or emails of the users that this task is assigned to.

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

name: string

The name of the task.

tags: string[]

(Optional) OID or names of the tags to be added to the new created task. Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) An optional priority. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

(Optional) An optional status. Its value must be between 0 and 100. Default: 0.

Request Example
{
  "description": "This is a *cool* task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "name": "Design new **logo**",
  "tags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "priority": 0,
  "status": 0
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new task after the given task.

POST /task/after/{oid}

Add a new task after the given task.

oid: string
in path

OID of the task that this new task to be added after.

description: string

(Optional) An optional description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks, if any.Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting). Default: false.

asUser: boolean

(Optional) Specify true if you'd like to make this new task as created by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of users who follow this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

assignees: string[]

(Optional) OID, ID or emails of the users that this task is assigned to.

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

name: string

The name of the task.

tags: string[]

(Optional) OID or names of the tags to be added to the new created task. Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) An optional priority. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

(Optional) An optional status. Its value must be between 0 and 100. Default: 0.

Request Example
{
  "description": "This is a *cool* task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "name": "Design new **logo**",
  "tags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "priority": 0,
  "status": 0
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Add a new task before the given task.

POST /task/before/{oid}

Add a new task before the given task.

oid: string
in path

OID of the task that this new task to be added before.

description: string

(Optional) An optional description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks, if any.Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting). Default: false.

asUser: boolean

(Optional) Specify true if you'd like to make this new task as created by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of users who follow this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

assignees: string[]

(Optional) OID, ID or emails of the users that this task is assigned to.

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

name: string

The name of the task.

tags: string[]

(Optional) OID or names of the tags to be added to the new created task. Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) An optional priority. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

(Optional) An optional status. Its value must be between 0 and 100. Default: 0.

Request Example
{
  "description": "This is a *cool* task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "name": "Design new **logo**",
  "tags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "priority": 0,
  "status": 0
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get an existing task by its ID.

GET /task/id/{projectId}/{id}

Returns the full task record for a single task.

projectId: string
in path

ID of the project that the task belongs to. Specify "-" if you'd like to retrieve the personal tasks that belong to no specific projects in My Tasks.

id: integer
in path

ID of the task that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get an existing task by its OID.

GET /task/{oid}

Returns the full task record for a single task.

oid: string
in path

OID of the task that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Get all subtasks of the given task.

GET /task/list/id/{projectId}/{taskId}

Returns all subtask records of the given task. Note: tasks in the same level are return. That is, it won't returns subtasks of subtasks. You have to retrieve them recursively.

projectId: string
in path

ID of the project. Specify "-" if you'd like to retrieve the personal tasks that belong to no specific projects in My Tasks

taskId: integer
in path

ID of the parent task.

status: string
in query

Task's status to match with. You can specify a value between 0 and 100, or "active" for active tasks, "completed" for completed tasks.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "id": 12,
    "name": "Design new **logo**",
    "nameHtml": "Design new <b>logo</b>",
    "nameText": "Design new logo",
    "description": "This is a *cool* task.",
    "descriptionHtml": "This is a <i>cool</i> task.",
    "descriptionText": "This is a cool task.",
    "recurring": {
      "type": 2048,
      "data": 6,
      "rate": 2048,
      "end": "2020-12-22T00:00:00.000Z"
    },
    "start": "2018-12-20T00:00:00.000Z",
    "due": "2018-12-22T00:00:00.000Z",
    "priority": 0,
    "status": 0,
    "partner": {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "assignors": [
      {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "partnerBy": "#/definitions/SimpleIdentity",
    "assignees": [
      "#/definitions/SimpleIdentity"
    ],
    "tags": [
      "#/definitions/SimpleTaggingEntity"
    ],
    "order": 99,
    "cover": "qfqVmUtC",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "childCount": 5,
    "referrers": [
      {
        "user": "wrSpgghWFCzPHBqiShSurDeD",
        "when": "2018-12-22T02:06:58.158Z",
        "task": "wrSpgghWFCzPHBqiShSurDeD"
      }
    ],
    "toggledAt": "2018-12-22T02:06:58.158Z",
    "toggledBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "peekaboo": true,
    "url": "https://quire.io/w/my_project/123",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "mutes": [
      "#/definitions/SimpleIdentity"
    ],
    "favorites": [
      "#/definitions/SimpleIdentity"
    ],
    "project": "#/definitions/SimpleIdentity",
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all root tasks of the given project or all subtasks of the given task.

GET /task/list/{oid}

Returns all root task records of the given project or all subtasks of the given task by OID. If the given OID is a project, the root tasks are returned. If the given OID is a task, its subtasks are returned. Note: tasks in the same level are return. That is, it won't returns subtasks of subtasks. You have to retrieve them recursively.

oid: string
in path

OID of project or parent task to look for. Specify "-" if you'd like to retrieve the personal tasks that belong to no specific projects in My Tasks.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "id": 12,
    "name": "Design new **logo**",
    "nameHtml": "Design new <b>logo</b>",
    "nameText": "Design new logo",
    "description": "This is a *cool* task.",
    "descriptionHtml": "This is a <i>cool</i> task.",
    "descriptionText": "This is a cool task.",
    "recurring": {
      "type": 2048,
      "data": 6,
      "rate": 2048,
      "end": "2020-12-22T00:00:00.000Z"
    },
    "start": "2018-12-20T00:00:00.000Z",
    "due": "2018-12-22T00:00:00.000Z",
    "priority": 0,
    "status": 0,
    "partner": {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "assignors": [
      {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "partnerBy": "#/definitions/SimpleIdentity",
    "assignees": [
      "#/definitions/SimpleIdentity"
    ],
    "tags": [
      "#/definitions/SimpleTaggingEntity"
    ],
    "order": 99,
    "cover": "qfqVmUtC",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "childCount": 5,
    "referrers": [
      {
        "user": "wrSpgghWFCzPHBqiShSurDeD",
        "when": "2018-12-22T02:06:58.158Z",
        "task": "wrSpgghWFCzPHBqiShSurDeD"
      }
    ],
    "toggledAt": "2018-12-22T02:06:58.158Z",
    "toggledBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "peekaboo": true,
    "url": "https://quire.io/w/my_project/123",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "mutes": [
      "#/definitions/SimpleIdentity"
    ],
    "favorites": [
      "#/definitions/SimpleIdentity"
    ],
    "project": "#/definitions/SimpleIdentity",
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Get all root tasks of the given project.

GET /task/list/id/{projectId}

Returns all root task records of the given project.

projectId: string
in path

ID of project. Specify "-" if you'd like to retrieve the personal tasks that belong to no specific projects in My Tasks.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "id": 12,
    "name": "Design new **logo**",
    "nameHtml": "Design new <b>logo</b>",
    "nameText": "Design new logo",
    "description": "This is a *cool* task.",
    "descriptionHtml": "This is a <i>cool</i> task.",
    "descriptionText": "This is a cool task.",
    "recurring": {
      "type": 2048,
      "data": 6,
      "rate": 2048,
      "end": "2020-12-22T00:00:00.000Z"
    },
    "start": "2018-12-20T00:00:00.000Z",
    "due": "2018-12-22T00:00:00.000Z",
    "priority": 0,
    "status": 0,
    "partner": {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    },
    "assignors": [
      {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "partnerBy": "#/definitions/SimpleIdentity",
    "assignees": [
      "#/definitions/SimpleIdentity"
    ],
    "tags": [
      "#/definitions/SimpleTaggingEntity"
    ],
    "order": 99,
    "cover": "qfqVmUtC",
    "attachments": [
      {
        "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
        "length": 2048,
        "name": "file.zip",
        "type": 2048,
        "createdBy": "#/definitions/SimpleIdentity",
        "createdAt": "2018-12-22T02:06:58.158Z"
      }
    ],
    "childCount": 5,
    "referrers": [
      {
        "user": "wrSpgghWFCzPHBqiShSurDeD",
        "when": "2018-12-22T02:06:58.158Z",
        "task": "wrSpgghWFCzPHBqiShSurDeD"
      }
    ],
    "toggledAt": "2018-12-22T02:06:58.158Z",
    "toggledBy": "#/definitions/SimpleIdentity",
    "editedAt": "2018-12-22T02:06:58.158Z",
    "peekaboo": true,
    "url": "https://quire.io/w/my_project/123",
    "followers": [
      "#/definitions/SimpleIdentity"
    ],
    "mutes": [
      "#/definitions/SimpleIdentity"
    ],
    "favorites": [
      "#/definitions/SimpleIdentity"
    ],
    "project": "#/definitions/SimpleIdentity",
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Searches tasks in the given project.

GET /task/search/{projectOid}

Returns task records that match the specified criteria in the given project.

projectOid: string
in path

OID of the project to search for the tasks. Specify "-" if you'd like to search the personal tasks that belong to no specific projects in My Tasks.

text: string
in query

Text to do a full-text search against the name, description, and attachments. Note: it doesn't include the content and attachment of comments.

name: string
in query

Task name to match with. To specify a regular expression, you can precede it with ~. To specify a case-insensitive regular expression, you can precede it with ~*. To do a full-text search, please use text instead.

description: string
in query

Task's description to match with. To specify a regular expression, you can precede it with ~. To specify a case-insensitive regular expression, you can precede it with ~*.

sublist: string
in query

ID or OID of task's sublist to match with.

status: string
in query

Task's status to match with. You can specify a value between 0 and 100, or "active" for active tasks, "completed" for completed tasks.

scheduled: boolean
in query

Whether to return only tasks that are scheduled. By scheduled we mean either start or due is scheduled. If scheduled=false is specified, it returns only tasks that neither start nor due is scheduled.

mine: boolean
in query

Whether to return only My Tasks. By My Tasks we mean tasks that are assigned to me, or tasks that are created by me and scheduled, but not assigned to anyone.

limit: string
in query

The maximal number of tasks to return. Default: 30. That is, at most 30 tasks will be returned. You can specify "no" to return all matched tasks.

Note: If the project is on a free plan, the value cannot be larger than 30 or "no" (unlimited).

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "id": 12,
    "name": "Design new **logo**",
    "nameHtml": "Design new <b>logo</b>",
    "nameText": "Design new logo",
    "description": "This is a *cool* task.",
    "descriptionHtml": "This is a <i>cool</i> task.",
    "descriptionText": "This is a cool task.",
    "start": "2018-12-20T00:00:00.000Z",
    "due": "2018-12-22T00:00:00.000Z",
    "priority": 0,
    "status": 0,
    "assignees": [
      {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "tags": [
      {
        "color": "35",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "peekaboo": true,
    "url": "https://quire.io/w/my_project/123",
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Searches tasks in the given project.

GET /task/search/id/{projectId}

Returns task records that match the specified criteria in the given project.

projectId: string
in path

ID of the project to search for the tasks. Specify "-" if you'd like to search for the personal tasks that belong to no specific projects in My Tasks.

text: string
in query

Text to do a full-text search against the name, description, and attachments. Note: it doesn't include the content and attachment of comments. Also note: the update of tasks can take 10 seconds or more before it can be found by the full-text search.

name: string
in query

Task name to match with. To specify a regular expression, you can precede it with ~. To specify a case-insensitive regular expression, you can precede it with ~*. For example, name=~abc matches if abc is part of the name. name=~^ab.*ed$ matches if the name starts with ab and ends with ed. To do a full-text search, please use text instead.

description: string
in query

Task's description to match with. To specify a regular expression, you can precede it with ~. To specify a case-insensitive regular expression, you can precede it with ~*.

sublist: string
in query

ID or OID of task's sublist to match with.

status: string
in query

Task's status to match with. You can specify a value between 0 and 100.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
    "id": 12,
    "name": "Design new **logo**",
    "nameHtml": "Design new <b>logo</b>",
    "nameText": "Design new logo",
    "description": "This is a *cool* task.",
    "descriptionHtml": "This is a <i>cool</i> task.",
    "descriptionText": "This is a cool task.",
    "start": "2018-12-20T00:00:00.000Z",
    "due": "2018-12-22T00:00:00.000Z",
    "priority": 0,
    "status": 0,
    "assignees": [
      {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "tags": [
      {
        "color": "35",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      }
    ],
    "peekaboo": true,
    "url": "https://quire.io/w/my_project/123",
    "createdBy": "#/definitions/SimpleIdentity",
    "createdAt": "2018-12-22T02:06:58.158Z"
  }
]

Update an existing task by its ID.

PUT /task/id/{projectId}/{id}

Updates an existing task, and returns the full updated record.

projectId: string
in path

ID of the project that the task belongs to. Specify "-" if you'd like to update the personal tasks that belong to no specific projects in My Tasks.

id: integer
in path

ID of the task that needs to be updated

description: string

(Optional) Change the description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks. Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting).

asUser: boolean

(Optional) Specify true if you'd like to make this task as updated by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of the users to replace the followers of this task. Please refer to addFollowers() for more details.

assignees: string[]

(Optional) OID, ID emails of the users that this task is assigned to. If specified, it will replace any existing assignee(s). Instead of replacment, you can use "addAssignees" or "removeAssignees".

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

removeAssignees: string[]

(Optional) OID or ID of the assignees to be removed from this task.

addFollowers: string[]

(Optional) OID or ID of the followers to be added to this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

removeTags: string[]

(Optional) OID or names of the tags to be removed from this task. Note: if tag's name is specified, it is case-insensitive.

addTags: string[]

(Optional) OID or names of the tags to be added to this task. Note: if tag's name is specified, it is case-insensitive.

addAssignees: string[]

(Optional) OID or ID of the assignees to be added to this task.

removeFollowers: string[]

(Optional) OID or ID of the followers to be removed from this task.Please refer to addFollowers() for more details.

name: string

(Optional) New name of the task.

tags: string[]

(Optional) OID or names of the tags to replace existing tags of to this task. If specified, it will replace any existing tag(s). Instead of replacment, you can use "addTags" or "removeTags". Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) Change the priority of this task. Its value must be between -1 (lowest) and 2 (highest).

status: integer

(Optional) An optional status to change to. Its value must be between 0 and 100. To complete a task, specify 100.

Request Example
{
  "description": "This is a **cool** task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl",
    "app"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "removeAssignees": [
    "Job4NSW9xK6Owcke8iKj7zyH"
  ],
  "addFollowers": [
    "sfsvLbDVPvi1QMf2GkDn7VSy"
  ],
  "removeTags": [
    "mPAQrYU1qt8wAYAInKRlTnvl"
  ],
  "addTags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "addAssignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "removeFollowers": [
    "aBuz4MwfZ5CasOae6stnFa2f"
  ],
  "name": "New idea",
  "tags": [
    "ITaVbkhh3iVcEcV3vuSLeE2k"
  ],
  "priority": 0,
  "status": 100
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Update an existing task by its OID.

PUT /task/{oid}

Updates an existing task, and returns the full updated record.

oid: string
in path

OID of task that needs to be updated.

description: string

(Optional) Change the description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks. Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting).

asUser: boolean

(Optional) Specify true if you'd like to make this task as updated by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of the users to replace the followers of this task. Please refer to addFollowers() for more details.

assignees: string[]

(Optional) OID, ID emails of the users that this task is assigned to. If specified, it will replace any existing assignee(s). Instead of replacment, you can use "addAssignees" or "removeAssignees".

due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

removeAssignees: string[]

(Optional) OID or ID of the assignees to be removed from this task.

addFollowers: string[]

(Optional) OID or ID of the followers to be added to this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

removeTags: string[]

(Optional) OID or names of the tags to be removed from this task. Note: if tag's name is specified, it is case-insensitive.

addTags: string[]

(Optional) OID or names of the tags to be added to this task. Note: if tag's name is specified, it is case-insensitive.

addAssignees: string[]

(Optional) OID or ID of the assignees to be added to this task.

removeFollowers: string[]

(Optional) OID or ID of the followers to be removed from this task.Please refer to addFollowers() for more details.

name: string

(Optional) New name of the task.

tags: string[]

(Optional) OID or names of the tags to replace existing tags of to this task. If specified, it will replace any existing tag(s). Instead of replacment, you can use "addTags" or "removeTags". Note: if tag's name is specified, it is case-insensitive.

priority: integer

(Optional) Change the priority of this task. Its value must be between -1 (lowest) and 2 (highest).

status: integer

(Optional) An optional status to change to. Its value must be between 0 and 100. To complete a task, specify 100.

Request Example
{
  "description": "This is a **cool** task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl",
    "app"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "removeAssignees": [
    "Job4NSW9xK6Owcke8iKj7zyH"
  ],
  "addFollowers": [
    "sfsvLbDVPvi1QMf2GkDn7VSy"
  ],
  "removeTags": [
    "mPAQrYU1qt8wAYAInKRlTnvl"
  ],
  "addTags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "addAssignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "removeFollowers": [
    "aBuz4MwfZ5CasOae6stnFa2f"
  ],
  "name": "New idea",
  "tags": [
    "ITaVbkhh3iVcEcV3vuSLeE2k"
  ],
  "priority": 0,
  "status": 100
}
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Delete a task and all of its subtasks.

DELETE /task/{oid}

Delete an existing task and all of its subtasks.

oid: string
in path

OID of task that needs to be deleted

200 OK

ok

Response Content-Types: application/json

user

A user object represents an account in Quire that can be given access to various organizations, projects, and tasks.

Get a user by its ID or email address.

GET /user/id/{id}

Returns the full user record of the given ID or email address.

id: string
in path

ID, email address or "me" of user that needs to be fetched. Example: " john@gmail.com","me"

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/u/john",
  "name": "John",
  "id": "john",
  "nameHtml": "John",
  "nameText": "John",
  "email": "john@gmail.cc",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

Get a user by its OID.

GET /user/{oid}

Returns the full user record of the given OID.

oid: string
in path

OID of user that needs to be fetched

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "https://quire.io/u/john",
  "name": "John",
  "id": "john",
  "nameHtml": "John",
  "nameText": "John",
  "email": "john@gmail.cc",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

Get all user records.

GET /user/list

Returns all colleagues of the current user if he granted the app to access his contacts. Otherwise, it returns only colleagues who also authorized the same app. If the current user didn't grant the access of his contacts and none of his collegues authorized this app, only the current user's record will be returned. The first record must be the current user.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/u/john",
    "name": "John",
    "id": "john",
    "nameHtml": "John",
    "nameText": "John",
    "email": "john@gmail.cc",
    "website": "https://coolwebsites.com",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  }
]

Get all users records of the given project.

GET /user/list/project/id/{projectId}

Returns all members of the given project of the specified ID. If the current user doesn't grant the app to access his contacts, only basic information are returned. The first record must be the current user.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/u/john",
    "name": "John",
    "id": "john",
    "nameHtml": "John",
    "nameText": "John",
    "email": "john@gmail.cc",
    "website": "https://coolwebsites.com",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  }
]

Get all users records of the given project.

GET /user/list/project/{oid}

Returns all members of the given project of the specified OID. If the current user doesn't grant the app to access his contacts, only basic information are returned. The first record must be the current user.

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "url": "https://quire.io/u/john",
    "name": "John",
    "id": "john",
    "nameHtml": "John",
    "nameText": "John",
    "email": "john@gmail.cc",
    "website": "https://coolwebsites.com",
    "description": "This is *cool*!",
    "descriptionHtml": "This is <i>cool</i>!",
    "descriptionText": "This is cool!",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  }
]

Schema Definitions

Attachment: object

url: string

URL of this attachment.

length: integer

The size of this attachment. Unit: bytes.

name: string

Attachment's name.

type: integer

The type of this attachment.It is 1 if it is from Google Drive. It is 2 if it is stored in Quire.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
  "length": 2048,
  "name": "file.zip",
  "type": 2048,
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Change: object

task: string

The task's OID to be included or excluded.

exclude: boolean

Whether to exclude the task. Default: false (include).

single: boolean

Whether to include or exclude only the task. Default: false -- all descendants tasks will be included or excluded too. Note: it won't affect descendants that are explicitly excluded or included before this invocation.

Example
{
  "task": "2MmYOpJH_ZLeehIjjytH1Rwr",
  "exclude": false,
  "single": false
}

Comment: object

oid: string

OID, aka. UUID.

description: string

The content.

descriptionHtml: string

The content in a form of a HTML fragment converted from markdown.

descriptionText: string

The content but excluding markdown characters.

attachments: Attachment

The attachments of this task.

Attachment
url: string

Url of this comment on Quire website.

pinBy: SimpleIdentity

The user who pinned this comment, or null if not pinned.

pinAt: string

When this comment was pinned, or null if not pinned.

editedBy: SimpleIdentity

The user who edited this comment, or null if not edited.

editedAt: string

When this comment was edited, or null if not edited.

owner: CommentOwner

The object this comment was added to.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "oid": "iDsPd.QP_qM.hN.Trymukn8b",
  "description": "It is *cool*!",
  "descriptionHtml": "It is <i>cool</i>!",
  "descriptionText": "It is cool!",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": {
        "url": "https://quire.io/u/my_id",
        "id": "my_id",
        "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
        "iconColor": "37",
        "name": "Foo",
        "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
      },
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "url": "string",
  "pinBy": "#/definitions/SimpleIdentity",
  "pinAt": "2018-12-22T02:06:58.158Z",
  "editedBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

CommentOwner: object

url: string

Url of this record on Quire website.

type: string

The type of this object.

name: string

Name.

oid: string

OID, aka. UUID.

Example
{
  "url": "https://quire.io/u/my_id",
  "type": "Project",
  "name": "Foo",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

CreateCommentBody: object

description: string

The content of the new comment.

asUser: boolean

(Optional) Specify true if you'd like to make this new comment as created by the app. Default: false -- the comment is marked as created by the user authorizing the app.

pinned: boolean

(Optional) Whether to pin this comment. Default: false

Example
{
  "description": "Adjust style",
  "asUser": true,
  "pinned": false
}

CreateNotificationBody: object

url: string

(Optional) The URL of the message.If not omitted, a hyperlink will be generated to enclose the message.

message: string

The message

Example
{
  "url": "https://superheros.com/sync",
  "message": "Unable to synchronize"
}

CreateStatusBody: object

name: string

The name of the status

value: integer

The value. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.If not omitted, a color will be generated automatially.

Example
{
  "name": "Doing",
  "value": "true",
  "color": "35"
}

CreateSublistBody: object

description: string

(Optional) An optional description about this task.

name: string

The name of the sublist.

id: string

(Optional) ID of the sublist. If omitted, Quire will generate one automatically. It must be unquie in the whole project if specified

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

tasks: string[]

(Optional) A list of tasks' OID that belong to this sublist. Note: all of descendants will be included too.

string
iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

partner: string

(Optional) OID of the external team that this sublist belongs to.

personal: boolean

(Optional) Whether it is personal. If omitted, false is assumed.

due: string

(Optional) When this sublist was aimed to complete.

Example
{
  "description": "**Great** sublist to start with.",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "tasks": [
    "string"
  ],
  "iconColor": "37",
  "partner": "rcBHBYXZSiyDRrHrWPutatfF",
  "personal": "boolean",
  "due": "2020-01-22T02:06:58.158Z"
}

CreateTagBody: object

name: string

The name of the tag

global: boolean

(Optional) Whether this tag is global. If omitted, it is not glboal.

color: string

(Optional) The color of the tag.If not omitted, a color will be generated automatially.

Example
{
  "name": "Later",
  "global": true,
  "color": "35"
}

CreateTaskBody: object

description: string

(Optional) An optional description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks, if any.Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting). Default: false.

asUser: boolean

(Optional) Specify true if you'd like to make this new task as created by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of users who follow this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

string
assignees: string[]

(Optional) OID, ID or emails of the users that this task is assigned to.

string
due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

name: string

The name of the task.

tags: string[]

(Optional) OID or names of the tags to be added to the new created task. Note: if tag's name is specified, it is case-insensitive.

string
priority: integer

(Optional) An optional priority. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

(Optional) An optional status. Its value must be between 0 and 100. Default: 0.

Example
{
  "description": "This is a *cool* task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "name": "Design new **logo**",
  "tags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "priority": 0,
  "status": 0
}

Organization: object

url: string

Url of this record on Quire website.

name: string

Name.

id: string

ID.

email: string

Email address.

nameHtml: string

Name in a form of a HTML fragment converted from markdown.

nameText: string

Name but excluding markdown characters.

website: string

Website.

description: string

Description.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

oid: string

OID, aka. UUID.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "url": "https://quire.io/c/my_organization",
  "name": "My Organization",
  "id": "my_organization",
  "email": "info@compony.com",
  "nameHtml": "My Organization",
  "nameText": "My Organization",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdBy": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Partner: object

name: string

The name.

color: string

The color. It is an index of our predefined color palette. The first digit is between 0 and 5, and the second between 0 and 7. The color palette can be found in our Quire's color picker.

oid: string

OID, aka. UUID.

image: string
project: SimpleIdentity

The project this object belongs to.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "name": "UI design team",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Project: object

organization: SimpleIdentity

The organization this project belongs to.

url: string

Url of this record on Quire website.

name: string

Name.

id: string

ID.

activeCount: integer

Number of active tasks in this project.

taskCount: integer

Total number of tasks in this project.

nameHtml: string

Name in a form of a HTML fragment converted from markdown.

nameText: string

Name but excluding markdown characters.

rootCount: integer

Number of root tasks in this project.

description: string

Description.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

oid: string

OID, aka. UUID.

archivedAt: string

When this project was archived (aka., peekaboo). It is null if not archived.

editedAt: string

When this record was edited last time.

followers: SimpleIdentity

Users who follow this task.

SimpleIdentity
attachments: Attachment

The attachments of this task.

Attachment
createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "organization": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "url": "https://quire.io/w/my_project",
  "name": "My Project",
  "id": "my_project",
  "activeCount": 20,
  "taskCount": 30,
  "nameHtml": "My Project",
  "nameText": "My Project",
  "rootCount": 5,
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "archivedAt": "2018-12-22T02:06:58.158Z",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Recurring: object

type: integer

The type of this recurring.It is 0 if it is weekly. It is 1 if it is monthly. It is 2 if it is yearly. It is 3 if it is custom.

data: integer

It depends on the type of this recurring. If weekly, bit 0 is Sunday, bit 1 is Monday and so on. For example, if the data is 6, it means every Monday and Tuesday.

rate: integer

How often this recurring shall occur. If the rate is 2 and the type is weekly, it means it shall occur every two week. If the type is custom, it means number of days to repeat.

end: string

When this recurring shall end. If not specified, it means it is never end.

Example
{
  "type": 2048,
  "data": 6,
  "rate": 2048,
  "end": "2020-12-22T00:00:00.000Z"
}

Referrer: object

user: string

OID of the user who made this reference.

when: string

When this reference is made.

task: string

OID of the task that refers another task.

Example
{
  "user": "wrSpgghWFCzPHBqiShSurDeD",
  "when": "2018-12-22T02:06:58.158Z",
  "task": "wrSpgghWFCzPHBqiShSurDeD"
}

SimpleIdentity: object

url: string

Url of this record on Quire website.

id: string

ID.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

name: string

Name.

oid: string

OID, aka. UUID.

Example
{
  "url": "https://quire.io/u/my_id",
  "id": "my_id",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "name": "Foo",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

SimpleTaggingEntity: object

color: string

The color. It is an index of our predefined color palette. The first digit is between 0 and 5, and the second between 0 and 7. The color palette can be found in our Quire's color picker.

name: string

Name.

oid: string

OID, aka. UUID.

Example
{
  "color": "35",
  "name": "Foo",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

SimpleTask: object

oid: string

OID, aka. UUID.

id: integer
name: string

This task's name.

nameHtml: string

This task's name in a form of a HTML fragment converted from markdown.

nameText: string

This task's name but excluding markdown characters.

description: string

Description about this task.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

start: string

When to start this task.Note: if time is specified, the millisecond will be 001. Otherwise, it is 000 (so are the hour, minute and second fields).

due: string

When to complete this task. Note: if time is specified, the millisecond will be 001. Otherwise, it is 000 (so are the hour, minute and second fields).

priority: integer

The priority of this task. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

The status of this task. Its value must be between 0 and 100. If 100, it means completed.

assignees: SimpleIdentity

Users who are assigned to this task.

SimpleIdentity
tags: SimpleTaggingEntity

Tags that are tagged to this task.

SimpleTaggingEntity
peekaboo: boolean

Whether this task was peekabooed. It is null if not peekabooed.

url: string

Url of this task on Quire website.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "assignees": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "tags": [
    {
      "color": "35",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Status: object

name: string

The name.

value: integer

The value. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

The color. It is an index of our predefined color palette. The first digit is between 0 and 5, and the second between 0 and 7. The color palette can be found in our Quire's color picker.

Example
{
  "name": "Doing",
  "value": 50,
  "color": "35"
}

StorageList: object

currentProject: string

Property name

latest: StorageMap

Property name.

myList: string[]

Property name.

string
Example
{
  "currentProject": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "latest": {
    "myKey": "My data"
  },
  "myList": [
    "string"
  ]
}

StorageMap: object

myKey: string

Property name

Example
{
  "myKey": "My data"
}

Sublist: object

url: string

Url of this record on Quire website.

name: string

Name.

id: string

ID.

nameHtml: string

Name in a form of a HTML fragment converted from markdown.

nameText: string

Name but excluding markdown characters.

description: string

Description.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

oid: string

OID, aka. UUID.

partner: SimpleTaggingEntity

The external team that this sublist belongs to. It is null if this sublist can't be accessed by a member of external teams.

due: string

When this sublist was aimed to complete, or null if not specified.

archivedAt: string

When this sublist was archived. It is null if not archived.

owner: SublistOwner

The project this sublist belongs to.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "url": "https://quire.io/w/my_project?sublist=Sublist101",
  "name": "Sublist 101",
  "id": "Sublist101",
  "nameHtml": "Sublist 101",
  "nameText": "Sublist 101",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "due": "2020-01-22T02:06:58.158Z",
  "archivedAt": "2020-02-22T02:06:58.158Z",
  "owner": {
    "url": "https://quire.io/u/my_id",
    "type": "Project",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdAt": "2018-12-22T02:06:58.158Z"
}

SublistOwner: object

url: string

Url of this record on Quire website.

type: string

The type of this object.

id: string

ID.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

name: string

Name.

oid: string

OID, aka. UUID.

Example
{
  "url": "https://quire.io/u/my_id",
  "type": "Project",
  "id": "my_id",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "name": "Foo",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}

Tag: object

global: boolean

Whether this is a global tag. Note: it won't be returned if this is not a global tag.

name: string

The name.

color: string

The color. It is an index of our predefined color palette. The first digit is between 0 and 5, and the second between 0 and 7. The color palette can be found in our Quire's color picker.

oid: string

OID, aka. UUID.

project: SimpleIdentity

The project this object belongs to.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "global": true,
  "name": "Later",
  "color": "35",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "project": {
    "url": "https://quire.io/u/my_id",
    "id": "my_id",
    "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
    "iconColor": "37",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

Task: object

oid: string

OID, aka. UUID.

id: integer
name: string

This task's name.

nameHtml: string

This task's name in a form of a HTML fragment converted from markdown.

nameText: string

This task's name but excluding markdown characters.

description: string

Description about this task.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

recurring: Recurring

The recurring information of this task. It is null if it is not a recurring task.

start: string

When to start this task.Note: if time is specified, the millisecond will be 001. Otherwise, it is 000 (so are the hour, minute and second fields).

due: string

When to complete this task. Note: if time is specified, the millisecond will be 001. Otherwise, it is 000 (so are the hour, minute and second fields).

priority: integer

The priority of this task. Its value must be between -1 (lowest) and 2 (highest). Default: 0.

status: integer

The status of this task. Its value must be between 0 and 100. If 100, it means completed.

partner: SimpleTaggingEntity

The external team that this task belongs to. It is null if this task doesn't belong to any external team.

assignors: SimpleIdentity

Users who have assigned this tasks to a user. For example, the first item of assignees is assigned by the first item of assignors.

SimpleIdentity
partnerBy: SimpleIdentity

The user who assigned this task to an external team. It is null if this task doesn't belong to any external team.

assignees: SimpleIdentity

Users who are assigned to this task.

SimpleIdentity
tags: SimpleTaggingEntity

Tags that are tagged to this task.

SimpleTaggingEntity
order: integer

The order of this task shown on the board view. The smaller the number is, the ealier the task is shown. It is meaningless if not in a board view.

cover: string

The id of the attachment that is used as a cover of this task.

attachments: Attachment

The attachments of this task.

Attachment
childCount: integer

Number of subtasks of this task. To retrieve these subtasks, make the GET request to "/task/list/{oid}".

referrers: Referrer

A list of referrers that refer this task. Note: some of them might no longer exist.

Referrer
toggledAt: string

When this task's status was changed last time.

toggledBy: SimpleIdentity

The user who changed this task's status.

editedAt: string

When this record was edited last time.

peekaboo: boolean

Whether this task was peekabooed. It is null if not peekabooed.

url: string

Url of this task on Quire website.

followers: SimpleIdentity

Users who follow this task.

SimpleIdentity
mutes: SimpleIdentity

Users who don't want any nofications of this task even they're assinged to it.

SimpleIdentity
favorites: SimpleIdentity

Users who favorite this task.

SimpleIdentity
project: SimpleIdentity

The project this task belongs to.

createdBy: SimpleIdentity

The user who created this record.

createdAt: string

When this record was created.

Example
{
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "id": 12,
  "name": "Design new **logo**",
  "nameHtml": "Design new <b>logo</b>",
  "nameText": "Design new logo",
  "description": "This is a *cool* task.",
  "descriptionHtml": "This is a <i>cool</i> task.",
  "descriptionText": "This is a cool task.",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "start": "2018-12-20T00:00:00.000Z",
  "due": "2018-12-22T00:00:00.000Z",
  "priority": 0,
  "status": 0,
  "partner": {
    "color": "35",
    "name": "Foo",
    "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
  },
  "assignors": [
    {
      "url": "https://quire.io/u/my_id",
      "id": "my_id",
      "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
      "iconColor": "37",
      "name": "Foo",
      "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
    }
  ],
  "partnerBy": "#/definitions/SimpleIdentity",
  "assignees": [
    "#/definitions/SimpleIdentity"
  ],
  "tags": [
    "#/definitions/SimpleTaggingEntity"
  ],
  "order": 99,
  "cover": "qfqVmUtC",
  "attachments": [
    {
      "url": "https://quire.io/att/Ta/sdcQOGgeUtyaFFzb9p0IwAgi/qfqVmUtC/image.png",
      "length": 2048,
      "name": "file.zip",
      "type": 2048,
      "createdBy": "#/definitions/SimpleIdentity",
      "createdAt": "2018-12-22T02:06:58.158Z"
    }
  ],
  "childCount": 5,
  "referrers": [
    {
      "user": "wrSpgghWFCzPHBqiShSurDeD",
      "when": "2018-12-22T02:06:58.158Z",
      "task": "wrSpgghWFCzPHBqiShSurDeD"
    }
  ],
  "toggledAt": "2018-12-22T02:06:58.158Z",
  "toggledBy": "#/definitions/SimpleIdentity",
  "editedAt": "2018-12-22T02:06:58.158Z",
  "peekaboo": true,
  "url": "https://quire.io/w/my_project/123",
  "followers": [
    "#/definitions/SimpleIdentity"
  ],
  "mutes": [
    "#/definitions/SimpleIdentity"
  ],
  "favorites": [
    "#/definitions/SimpleIdentity"
  ],
  "project": "#/definitions/SimpleIdentity",
  "createdBy": "#/definitions/SimpleIdentity",
  "createdAt": "2018-12-22T02:06:58.158Z"
}

UpdateCommentBody: object

description: string

(Optional) The new content of the comment.

pinned: boolean

(Optional) Whether to pin this comment.

Example
{
  "description": "Adjust style",
  "pinned": false
}

UpdateProjectBody: object

followers: string[]

(Optional) OID of the users to replace the followers of this project. Please refer to addFollowers() for more details.

string
addFollowers: string[]

(Optional) OID of the followers to be added to this project.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

string
removeFollowers: string[]

(Optional) OID of the followers to be removed from this project. Please refer to addFollowers() for more details.

string
Example
{
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl",
    "app"
  ],
  "addFollowers": [
    "sfsvLbDVPvi1QMf2GkDn7VSy"
  ],
  "removeFollowers": [
    "aBuz4MwfZ5CasOae6stnFa2f"
  ]
}

UpdateStatusBody: object

name: string

(Optional) The new name of the status.

value: integer

(Optional) The new value of the status. It is a non-negative value to indicate the progress. The value must be unique. If it is great or equals to 100, it means the task has been completed.

color: string

(Optional) The color of the status.

Example
{
  "name": "Later",
  "value": "true",
  "color": "35"
}

UpdateSublistBody: object

description: string

(Optional) An optional description about this task.

due: string

(Optional) When this sublist was aimed to complete.

name: string

(Optional) The name of the sublist.

id: string

(Optional) ID of the sublist.

image: string

(Optional) The image representing this record. It shall be one of the predined images: 'icon-view-list', 'icon-view-kanban', 'icon-briefcase-o', 'icon-rocket-o', 'icon-bug-o', 'icon-leaf-o', 'icon-clapperboard', 'icon-sitemap-o', 'icon-flash-on-o', 'icon-piggy-bank-o', 'icon-graduation-cap-o', 'icon-paper-plane-o', 'icon-globe-o', 'icon-music-o', 'icon-detail', 'icon-beach-o', 'icon-paper', 'icon-home-o', 'icon-building', 'icon-database-o', 'icon-microscope-o', 'icon-hamburger-o', 'icon-trophy-o', 'icon-thumbs-o-up', 'icon-thumbs-o-down', 'icon-smile-o', 'icon-frown-o', 'icon-meh-o', 'icon-bullseye', 'icon-square-dotted-o'

iconColor: string

(Optional) The color of the icon representing this record. It is an index of our predefined color palette.

changes: Change

(Optional) A list of changes to control what tasks to be added to or removed from this sublist.

Change
archived: boolean

(Optional) Specify true to archive this sublist. Or, specify false to undo the previous archiving if any.

Example
{
  "description": "**Great** sublist to start with.",
  "due": "2020-01-22T02:06:58.158Z",
  "name": "Sublist 101",
  "id": "Sublist101",
  "image": "icon-view-kanban",
  "iconColor": "37",
  "changes": [
    {
      "task": "2MmYOpJH_ZLeehIjjytH1Rwr",
      "exclude": false,
      "single": false
    }
  ],
  "archived": true
}

UpdateTagBody: object

name: string

(Optional) The new name of the tag.

global: boolean

(Optional) Whether this tag is global. If you specify false here, you have to specify "project" for what project you'd like to put the tag to.

project: string

(Optional) OID of the project this tag shall be limited to. It is used only if "global" is also specified and false. Otherwise, it is simply ignored.

color: string

(Optional) The color of the tag.

Example
{
  "name": "Later",
  "global": true,
  "project": "Dyh2YkFcu9uLgLFIeN1kB4Ld",
  "color": "35"
}

UpdateTaskBody: object

description: string

(Optional) Change the description about this task.

start: string

(Optional) An optional start time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

recurring: Recurring

(Optional) The recurring information of this task. It is null if it is not a recurring task.

peekaboo:
boolean
integer

(Optional) Specify true or a positive integer to peekaboo this task and its subtasks. Or, specify false to undo the previous peekaboo if any. If a positive integer is specified, it is the number of days to peekaboo a task. If true, the default number of days will be used (depending on the project's setting).

asUser: boolean

(Optional) Specify true if you'd like to make this task as updated by the app. Default: false -- the task is marked as created by the user authorizing the app.

followers: string[]

(Optional) OID, ID or emails of the users to replace the followers of this task. Please refer to addFollowers() for more details.

string
assignees: string[]

(Optional) OID, ID emails of the users that this task is assigned to. If specified, it will replace any existing assignee(s). Instead of replacment, you can use "addAssignees" or "removeAssignees".

string
due: string

(Optional) An optional due time. If you'd like to specify time, use yyyy-mm-ddThh:mmZ, e.g., 2020-10-30T09:30Z. If you don't like to set time, use yyyy-mm-dd, e.g., 2020-10-30.Note: they must be in UTC time.

removeAssignees: string[]

(Optional) OID or ID of the assignees to be removed from this task.

string
addFollowers: string[]

(Optional) OID or ID of the followers to be added to this task.If "me" is specified, it means the current user will follow this task. If the application would like to follow (i.e., receive notifications), it can pass "app" as one of OIDs. In additions, it can pass additional information in one of the following syntaxes.

Syntax 1: "app|team" or "app|team|channel" where team and channel can be any value.

Syntax 2: "app|/path" where "/path" can be any URL path. It will be appended to the hook's URL when calling the registered hook. For example, if the hook URL is " https://super.app/hooks/standard" and the follower is "app|/soc1/33456/a7", then the notification will be sent to " https://super.app/hooks/standard/soc1/33456/a7".

string
removeTags: string[]

(Optional) OID or names of the tags to be removed from this task. Note: if tag's name is specified, it is case-insensitive.

string
addTags: string[]

(Optional) OID or names of the tags to be added to this task. Note: if tag's name is specified, it is case-insensitive.

string
addAssignees: string[]

(Optional) OID or ID of the assignees to be added to this task.

string
removeFollowers: string[]

(Optional) OID or ID of the followers to be removed from this task.Please refer to addFollowers() for more details.

string
name: string

(Optional) New name of the task.

tags: string[]

(Optional) OID or names of the tags to replace existing tags of to this task. If specified, it will replace any existing tag(s). Instead of replacment, you can use "addTags" or "removeTags". Note: if tag's name is specified, it is case-insensitive.

string
priority: integer

(Optional) Change the priority of this task. Its value must be between -1 (lowest) and 2 (highest).

status: integer

(Optional) An optional status to change to. Its value must be between 0 and 100. To complete a task, specify 100.

Example
{
  "description": "This is a **cool** task.",
  "start": "2018-12-20T00:00:00.000Z",
  "recurring": {
    "type": 2048,
    "data": 6,
    "rate": 2048,
    "end": "2020-12-22T00:00:00.000Z"
  },
  "peekaboo": true,
  "asUser": true,
  "followers": [
    "tzufRLqCnud74dARyDSvjWDl",
    "app"
  ],
  "assignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "due": "2018-12-22T00:00:00.000Z",
  "removeAssignees": [
    "Job4NSW9xK6Owcke8iKj7zyH"
  ],
  "addFollowers": [
    "sfsvLbDVPvi1QMf2GkDn7VSy"
  ],
  "removeTags": [
    "mPAQrYU1qt8wAYAInKRlTnvl"
  ],
  "addTags": [
    "X6nmx9XjEO2wKbqeB1pRT43C"
  ],
  "addAssignees": [
    "6QMKkEPBVWETLWrXqws94ALU"
  ],
  "removeFollowers": [
    "aBuz4MwfZ5CasOae6stnFa2f"
  ],
  "name": "New idea",
  "tags": [
    "ITaVbkhh3iVcEcV3vuSLeE2k"
  ],
  "priority": 0,
  "status": 100
}

User: object

url: string

Url of this record on Quire website.

name: string

Name.

id: string

ID.

nameHtml: string

Name in a form of a HTML fragment converted from markdown.

nameText: string

Name but excluding markdown characters.

email: string

Email address.

website: string

Website.

description: string

Description.

descriptionHtml: string

Description in a form of a HTML fragment converted from markdown.

descriptionText: string

Description but excluding markdown characters.

image: string

The image representing this record.

iconColor: string

The color of the icon representing this record. It is an index of our predefined color palette.

oid: string

OID, aka. UUID.

Example
{
  "url": "https://quire.io/u/john",
  "name": "John",
  "id": "john",
  "nameHtml": "John",
  "nameText": "John",
  "email": "john@gmail.cc",
  "website": "https://coolwebsites.com",
  "description": "This is *cool*!",
  "descriptionHtml": "This is <i>cool</i>!",
  "descriptionText": "This is cool!",
  "image": "https://quire.s3.amazonaws.com/oid/image.jpg",
  "iconColor": "37",
  "oid": "Dyh2YkFcu9uLgLFIeN1kB4Ld"
}