Weeek Public API
  1. Task
Weeek Public API
  • Get started
  • Workspace
    • Tag
      • Tag list
      • Create tag
      • Tag
      • Update tag
      • Delete tag
    • Get workspace info
      GET
    • Get workspace members
      GET
  • Task Manager
    • Portfolio
      • Get portfolios
      • Create portfolio
      • Get portfolio
      • Update portfolio
      • Delete portfolio
    • Project
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get project list
      • Create project
      • Update project info
      • Delete project
      • Get project
      • Archive project
      • Un Archive project
    • Board
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get board list
      • Create board
      • Update board
      • Delete board
      • Move board
    • BoardColumn
      • Get board column list
      • Create board column
      • Update board column
      • Delete board column
      • Move board column
    • Task
      • Attachments
        • Upload attachments
      • Time Entries
        • Create a time entry
        • Update a time entry
        • Delete a time entry
      • Watchers
        • Add watchers to a task
        • Remove watchers from a task
      • Get tasks
        GET
      • Create task
        POST
      • Get one task info
        GET
      • Update a task
        PUT
      • Delete task
        DELETE
      • Complete task
        POST
      • Un complete task
        POST
      • Change board
        POST
      • Change board column
        POST
    • Custom Fields
      • Options
        • Create global custom field option
        • Update global custom field option
        • Move global custom field option
        • Delete global custom field option
      • Get global custom fields
      • Create global custom field
      • Update global custom field
      • Transfer global custom field to project
      • Transfer global custom field to board
      • Delete global custom field
  • CRM
    • Funnels
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Move a custom field
        • Delete a custom field
      • Get all funnels
      • Create a funnel
      • Get a funnel
      • Update a funnel
      • Delete a funnel
    • Funnel Statuses
      • Get all funnel statuses
      • Create a funnel status
      • Get a funnel status
      • Update a funnel status
      • Delete a funnel status
    • Deals
      • Assignees
        • Attach an assignee
        • Detach an assignee
      • Contacts
        • Attach a contact
        • Detach a contact
      • Organizations
        • Attach an organization
        • Detach an organization
      • Tags
        • Attach a tag
        • Detach a tag
      • Tasks
        • Attach a new task
        • Move a attached to the deal task
        • Detach a task
      • Attachments
        • Upload attachments
      • Get all deals
      • Create a deal
      • Get a deal
      • Update a deal
      • Update a deal fields
      • Move a deal
      • Delete a deal
      • Update the deal funnel
      • Update the deal funnel status
    • Organizations
      • Addresses
        • Create an address
        • Update the address
        • Delete the address
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Contacts
        • Attach a contact
        • Detach the contact
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Delete an organization
    • Contacts
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all contacts
      • Create a contact
      • Get a contact
      • Update a contact
      • Delete a contact
    • Currencies
      • Get all currencies
  • User
    • Get profile
  • Attachments
    • Get an attachment
  1. Task

Get one task info

GET
/tm/tasks/{id}
Task

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required

Responses

🟢200Successful response
application/json
Body
success
boolean 
optional
task
object (Task) 
optional
id
integer 
optional
parentId
integer  | null 
optional
title
string 
optional
description
string  | null 
optional
duration
integer  | null 
optional
In minutes
overdue
integer 
required
type
enum<string> 
optional
Allowed values:
actionmeetcall
priority
integer  | null 
optional
0 - Low
1 - Medium
2 - High
3 - Hold
>= 0<= 3
isCompleted
boolean 
optional
authorId
string 
optional
ID of the user who created the task
userId
string  | null 
optional
ID of the user who is executing the task
boardId
integer  | null 
optional
boardColumnId
integer  | null 
optional
projectId
integer  | null 
optional
image
string  | null 
optional
isPrivate
boolean 
optional
startDate
string <date> | null 
optional
Start date of the task in Y-m-d format
startDateTime
string <date-time> | null 
optional
Start date of the task in ISO 8601 format
dueDate
string <date> | null 
optional
Due date of the task in Y-m-d format
dueDateTime
string <date-time> | null 
optional
Due date of the task in ISO 8601 format
createdAt
string <date-time>
required
Date the task was created in ISO 8601 format
updatedAt
string <date-time>
required
Date the task was last updated in ISO 8601 format
tags
array[integer]
optional
subscribers
array[string]
optional
subTasks
array[integer]
optional
workloads
array [object {7}] 
optional
timeEntries
array[object (Time entry) {6}] 
required
customFields
array[object (CustomFieldValue) {6}] 
optional
attachments
array[object (Attachment) {7}] 
optional
Example
{
  "success": true,
  "task": {
    "id": 4,
    "parentId": null,
    "title": "To deal with the font on the One Ring",
    "description": "The ring interface needs to be redesigned. UX tests show that the font is small and generally illegible, moreover, not everyone gets to heat it up (the test report attached to the task). It's not urgent, but you should try not to forget about the task, it'll remind you about itself.",
    "date": "01.01.1970",
    "time": "23:00",
    "duration": 60,
    "type": "action",
    "priority": 2,
    "isCompleted": false,
    "authorId": "3e265f8a-5c6c-4169-a2b1-6182f10b712b",
    "userId": null,
    "boardId": null,
    "boardColumnId": null,
    "projectId": 4,
    "image": null,
    "isPrivate": false,
    "dateStart": null,
    "dateEnd": null,
    "timeStart": null,
    "timeEnd": null,
    "tags": [
      1,
      2
    ],
    "subscribers": [
      "3e265f8a-5c6c-4169-a2b1-6182f10b712b"
    ],
    "workloads": [
      {
        "id": "bc92d5f2-3aaf-49cc-8010-5007ced66ea6",
        "userId": "24d20bfa-bc7e-471e-8c17-a199734532dc",
        "type": 2,
        "date": "05.10.2022",
        "duration": 60,
        "workStartAt": null,
        "workEndAt": null
      }
    ]
  }
}
Modified at 2024-02-16 12:45:20
Previous
Create task
Next
Update a task
Built with