Nifty API
  • Authentication
  • OAuth 2.1
  • v1.0 API
  • API tokens
Information
Apps
    Get AppsgetGet Appget
Authentication
    Generate TokenpostAuthorize (browser entry point)get
Chats
    Get ChatsgetGet Chatget
Documents
    Get DocumentsgetCreate documentpostGet Personal DocumentsgetCreate Personal DocumentpostGet DocumentgetUpdate DocumentputRemove DocumentdeleteMove DocumentputUpdate Document MemberputRemove Document MemberdeleteUpdate DocumentpostUpdate Document LabelsputRemove Document Labelsdelete
Custom Fields
    Get Custom fieldsgetGet Custom fieldget
Files
    Get FilesgetUpload FilespostGet FilegetUpdate FileputRemove FiledeleteCopy FilepostAdd File LabelsputRemove File Labelsdelete
Folders
    Get Folder ChildrengetAdd FolderpostGet Folderget/api/v2.0/folders/{folderId}putRemove FolderdeleteGet Folder Conntentsget
Invite
    Get Inviteeget
Tags
    Get TagsgetCreate TagpostGet TaggetUpdate TagputRemove Tagdelete
Members
    Get Members DetailsgetGet Member Detailsget
Messages
    Get MessagesgetCreate MessagepostGet MessagegetUpdate MessageputRemove MessagedeleteMark Message seenpostMark Message heardpost
Milestones & Lists
    Get MilestonesgetCreate MilestonepostGet MilestonegetUpdate MilestoneputRemove MilestonedeleteMove MilestoneputTie Task To MilestoneputRemove Milestone TaskdeleteArchive Milestonepost
Projects
    Get ProjectsgetCreate ProjectpostGet ProjectgetUpdate ProjectputRemove ProjectdeleteInvite Team Member for projectpostLeave ProjectpostStart ProjectpostGet Project Custom FieldsgetAdd Project Custom FieldspostUpdate Project Custom Fieldsput
Portfolios
    Get PortfoliosgetCreate PortfoliopostGet PortfoliogetUpdate PortfolioputRemove PortfoliodeleteUpdate Portfolio MemberputRemove Portfolio MemberdeleteLeave Portfoliopost
Tasks
    Get TasksgetCreate TaskpostRemove TaskdeleteGet Personal TasksgetCreate Personal TaskpostGet TaskgetUpdate TaskputRemove TaskdeleteUpdate Task MilestoneputComplete TaskpostArchive TaskpostMove TaskpostAssign TaskputRemove AssigneedeleteAdd LabelsputRemove LabelsdeleteGet FieldsgetAdd FieldspostUpdate FieldsputAdd DocumentputClone TaskpostMove Taskpost
Status
    Get StatusesgetCreate StatuspostGet StatusgetUpdate StatusputRemove StatusdeleteMove TaskspostAssign Status MembersputRemove Status Memberdelete
Templates
    Get Templatesget
Time Tracking
    Get Tracked Time ReportgetGet Tracked Time Durationget
Users
    Get User Detailsget
Webhook
    Get WebhooksgetCreate WebhookpostUpdate WebhookputRemove Webhookdelete
Other endpoints
    /get
Schemas
powered by Zudoku
Nifty API v1.0
Nifty API v1.0

Tasks


Get Tasks

GET
https://openapi.niftypm.com
/api/v1.0/tasks

This endpoint fetch the list of tasks for the team member.

Get Tasks › query Parameters

project_id
​string

Project ID

task_group_id
​string

Task Group ID

task_id
​string

Task ID

member_id
​string

Member ID

meeting_id
​string

Meeting ID

milestone_id
​string

Milestone ID

completed_by
​string

Completed By

archived
​string

Archived

include_archived
​string

Include Archived

completed
​string

Completed

limit
​string

No of records per page

Example: 25
offset
​string

Record Offset

Example: 0
order
​string · enum

Name of the field to sort record. It should be one of below value with either ASC or DESC. For example, completedOn:DESC, to sort record based on completion date in descending order

Enum values:
dueDate
archivedOn
completedOn
from
​string

From

to
​string

To

archived_from
​string

Archived From

archived_to
​string

Archived To

completed_from
​string

Completed From

completed_to
​string

Completed To

include_subtasks
​boolean

Include Subtask

sort
​string · enum

Sorting order, default is ascending

Enum values:
ascending
descending

Get Tasks › Responses

Success Response

GetTasksResponse
​TaskResponse[] · required

List of all tasks

hasMore
​boolean · required

True if there are more record else false

Default: false
GET/api/v1.0/tasks
curl https://openapi.niftypm.com/api/v1.0/tasks \ --header 'Authorization: Bearer <token>'
Example Responses
{ "tasks": [ {} ], "hasMore": false }
json
application/json

Create Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks

This endpoint creates the task for the team member.

Create Task › Request Body

CreateTaskBody
name
​string · required

Name

task_group_id
​string · required

Task Group ID

description
​string

Description

order
​number

Order

task_id
​string

Task Id. This field is mandatory only when we want to create this task as subtask of other task.

milestone_id
​string

Milestone ID

rule_id
​string

Rule ID

annotation_id
​string

Annotation ID

due_date
​string

Due Date

start_date
​string

Start Date

assignees
​string[]

List of Assignees

labels
​string[]

List of labels

meeting_ids
​string[]

List of meeting ID

embed_url
​string

Embed URL

banner
​string

Banner

​CreateTaskFieldBody[]

Task Field Body

story_points
​number

Story Points

dependency
​object

Dependency Task

Create Task › Responses

The resource created successfully

TaskResponse
POST/api/v1.0/tasks
curl https://openapi.niftypm.com/api/v1.0/tasks \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "name", "description": "description", "order": 0, "task_group_id": "task_group_id", "task_id": "task_id", "milestone_id": "milestone_id", "rule_id": "rule_id", "annotation_id": "annotation_id", "due_date": "due_date", "start_date": "start_date", "assignees": [ "string" ], "labels": [ "string" ], "meeting_ids": [ "string" ], "embed_url": "embed_url", "banner": "banner", "fields": [ { "id": "id", "value": "value" } ], "story_points": 0, "dependency": {} }'
Example Request Body
{ "name": "name", "description": "description", "order": 0, "task_group_id": "task_group_id", "task_id": "task_id", "milestone_id": "milestone_id", "rule_id": "rule_id", "annotation_id": "annotation_id", "due_date": "due_date", "start_date": "start_date", "assignees": [ "string" ], "labels": [ "string" ], "meeting_ids": [ "string" ], "embed_url": "embed_url", "banner": "banner", "fields": [ { "id": "id", "value": "value" } ], "story_points": 0, "dependency": {} }
json
Example Responses
{}
json
application/json

Remove Task

DELETE
https://openapi.niftypm.com
/api/v1.0/tasks

This endpoint removes the task.

Remove Task › Request Body

RemoveTasks
project_id
​string

Project ID

task_ids
​string[]

List of Task ID

Remove Task › Responses

The record has been updated successfully.

UpdateTaskResponse
message
​string · required

Success message

DELETE/api/v1.0/tasks
curl https://openapi.niftypm.com/api/v1.0/tasks \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "project_id": "project_id", "task_ids": [ "string" ] }'
Example Request Body
{ "project_id": "project_id", "task_ids": [ "string" ] }
json
Example Responses
{ "message": "message" }
json
application/json

Get Personal Tasks

GET
https://openapi.niftypm.com
/api/v1.0/tasks/personal

This endpoint fetch the list of personal tasks for the team member.

Get Personal Tasks › query Parameters

limit
​string · required

No of records per page

Example: 25
offset
​string

Record Offset

Example: 0
meeting_id
​string

Meeting ID

completed
​boolean

Completed?

Get Personal Tasks › Responses

Success Response

GetTasksResponse
​TaskResponse[] · required

List of all tasks

hasMore
​boolean · required

True if there are more record else false

Default: false
GET/api/v1.0/tasks/personal
curl 'https://openapi.niftypm.com/api/v1.0/tasks/personal?limit=<string>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "tasks": [ {} ], "hasMore": false }
json
application/json

Create Personal Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/personal

This endpoint creates a personal task for the team member.

Create Personal Task › Request Body

GetPersonalTasksDto
limit
​string · required

No of records per page

Example: 25
offset
​string

Record Offset

Example: 0
meeting_id
​string

Meeting ID

completed
​boolean

Completed?

Create Personal Task › Responses

The resource created successfully

Task
POST/api/v1.0/tasks/personal
curl https://openapi.niftypm.com/api/v1.0/tasks/personal \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "limit": "25", "offset": "0", "meeting_id": "meeting_id", "completed": true }'
Example Request Body
{ "limit": "25", "offset": "0", "meeting_id": "meeting_id", "completed": true }
json
Example Responses
{}
json
application/json

Get Task

GET
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}

This endpoint fetch the task details for the team member.

Get Task › path Parameters

task_id
​string · required

Enter task id

Get Task › Responses

Success Response

TaskResponse
GET/api/v1.0/tasks/{task_id}
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id \ --header 'Authorization: Bearer <token>'
Example Responses
{}
json
application/json

Update Task

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}

This endpoint update the task details.

Update Task › path Parameters

task_id
​string · required

Enter task id

Update Task › Responses

Success Response

UpdateTaskResponse
message
​string · required

Success message

PUT/api/v1.0/tasks/{task_id}
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id \ --request PUT \ --header 'Authorization: Bearer <token>'
Example Responses
{ "message": "message" }
json
application/json

Remove Task

DELETE
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}

This endpoint removes the task details.

Remove Task › path Parameters

task_id
​string · required

Enter task id

Remove Task › Responses

The record has been updated successfully.

RemoveTaskResponse
message
​string · required

Success message

DELETE/api/v1.0/tasks/{task_id}
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id \ --request DELETE \ --header 'Authorization: Bearer <token>'
Example Responses
{ "message": "message" }
json
application/json

Update Task Milestone

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/milestone

This endpoint adds milestone details for the task.

Update Task Milestone › path Parameters

task_id
​string · required

Enter task id

Update Task Milestone › Request Body

string

Update Task Milestone › Responses

Success Response

UpdateTaskMilestoneReponse
message
​string · required

Success message

PUT/api/v1.0/tasks/{task_id}/milestone
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/milestone \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data 'string'
Example Request Body
string
json
Example Responses
{ "message": "message" }
json
application/json

Complete Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/complete

This endpoint updates the task as completed.

Complete Task › path Parameters

task_id
​string · required

Enter task id

Complete Task › Request Body

boolean

Complete Task › Responses

The resource created successfully

CompletedTaskResponse
message
​string · required

Success message

POST/api/v1.0/tasks/{task_id}/complete
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/complete \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data 'true'
Example Request Body
true
json
Example Responses
{ "message": "message" }
json
application/json

Archive Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/archive

This endpoint archives the task.

Archive Task › path Parameters

task_id
​string · required

Enter task id

Archive Task › Request Body

boolean

Archive Task › Responses

The resource created successfully

CompletedTaskResponse
message
​string · required

Success message

POST/api/v1.0/tasks/{task_id}/archive
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/archive \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data 'true'
Example Request Body
true
json
Example Responses
{ "message": "message" }
json
application/json

Move Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/moveOrder

This endpoint moves the order of the task.

Move Task › path Parameters

task_id
​string · required

Enter task id

Move Task › Request Body

MoveTaskNew
​object · required
task_order
​string

Task Order

next_task
​string

Next Task

prev_task
​string

Previous Task

Move Task › Responses

The resource created successfully

CompletedTaskResponse
message
​string · required

Success message

POST/api/v1.0/tasks/{task_id}/moveOrder
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/moveOrder \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "to": { "type": "type", "id": "id" }, "task_order": "task_order", "next_task": "next_task", "prev_task": "prev_task" }'
Example Request Body
{ "to": { "type": "type", "id": "id" }, "task_order": "task_order", "next_task": "next_task", "prev_task": "prev_task" }
json
Example Responses
{ "message": "message" }
json
application/json

Assign Task

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/assignees

This endpoint adds assignee to the task.

Assign Task › path Parameters

task_id
​string · required

Enter task id

Assign Task › Request Body

AssigneesBody
assignees
​string[] · required

List of Assignees

Assign Task › Responses

Success Response

CompletedTaskResponse
message
​string · required

Success message

PUT/api/v1.0/tasks/{task_id}/assignees
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/assignees \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "assignees": [ "string" ] }'
Example Request Body
{ "assignees": [ "string" ] }
json
Example Responses
{ "message": "message" }
json
application/json

Remove Assignee

DELETE
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/assignees

This endpoint removes the assignee to the task.

Remove Assignee › path Parameters

task_id
​string · required

Enter task id

Remove Assignee › Request Body

AssigneesBody
assignees
​string[] · required

List of Assignees

Remove Assignee › Responses

The record has been updated successfully.

CompletedTaskResponse
message
​string · required

Success message

DELETE/api/v1.0/tasks/{task_id}/assignees
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/assignees \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "assignees": [ "string" ] }'
Example Request Body
{ "assignees": [ "string" ] }
json
Example Responses
{ "message": "message" }
json
application/json

Add Labels

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/labels

This endpoint adds the labels to the task.

Add Labels › path Parameters

task_id
​string · required

Enter task id

Add Labels › Request Body

UpdateLabels
labels
​string[] · required

Labels

Add Labels › Responses

Success Response

AddLabelsToTaskResponse
message
​string · required
labels
​string[] · required
PUT/api/v1.0/tasks/{task_id}/labels
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/labels \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "labels": [ "string" ] }'
Example Request Body
{ "labels": [ "string" ] }
json
Example Responses
{ "message": "message", "labels": [ "string" ] }
json
application/json

Remove Labels

DELETE
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/labels

This endpoint removes the labels from the task.

Remove Labels › path Parameters

task_id
​string · required

Enter task id

Remove Labels › Request Body

UpdateLabels
labels
​string[] · required

Labels

Remove Labels › Responses

The record has been updated successfully.

AddLabelsToTaskResponse
message
​string · required
labels
​string[] · required
DELETE/api/v1.0/tasks/{task_id}/labels
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/labels \ --request DELETE \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "labels": [ "string" ] }'
Example Request Body
{ "labels": [ "string" ] }
json
Example Responses
{ "message": "message", "labels": [ "string" ] }
json
application/json

Get Fields

GET
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/fields

This endpoint fetch the custom field of the task.

Get Fields › path Parameters

task_id
​string · required

Enter task id

Get Fields › Responses

Success Response

​AttachedCustomFieldResponse[]
AttachedCustomFieldResponse
id
​string · required

Id

value
​string · required

Value

GET/api/v1.0/tasks/{task_id}/fields
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/fields \ --header 'Authorization: Bearer <token>'
Example Responses
[ { "id": "id", "value": "value" } ]
json
application/json

Add Fields

POST
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/fields

This endpoint adds the custom field to the task.

Add Fields › path Parameters

task_id
​string · required

Enter task id

Add Fields › Request Body

CreateCustomField
name
​string · required

Custom field name

type
​number · enum · required

Custom field type

Enum values:
0
1
2
3
4
5
6
7
​CustomFieldOptions[] · required
roles
​string[] · required

Roles

field_id
​string

field_id

description
​string

description

currency
​string

Currency

tracking_type
​number · enum

Tracking Type

Enum values:
0
1
cost_per_hour
​number

Cost per hour

save
​boolean

Save

association
​string

Association

project_id
​string

Project ID

Add Fields › Responses

The resource created successfully

No data returned
POST/api/v1.0/tasks/{task_id}/fields
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/fields \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "field_id": "field_id", "name": "name", "description": "description", "type": 0, "currency": "currency", "tracking_type": 0, "cost_per_hour": 0, "options": [ { "value": "value", "color": "color" } ], "roles": [ "string" ], "save": true, "association": "association", "project_id": "project_id" }'
Example Request Body
{ "field_id": "field_id", "name": "name", "description": "description", "type": 0, "currency": "currency", "tracking_type": 0, "cost_per_hour": 0, "options": [ { "value": "value", "color": "color" } ], "roles": [ "string" ], "save": true, "association": "association", "project_id": "project_id" }
json
Example Responses
No example specified for this content type

Update Fields

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/fields/{field_id}

This endpoint updates the custom field detail of the task.

Update Fields › path Parameters

task_id
​string · required

Enter task id

field_id
​string · required

Update Fields › Responses

Success Response

No data returned
PUT/api/v1.0/tasks/{task_id}/fields/{field_id}
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/fields/:field_id \ --request PUT \ --header 'Authorization: Bearer <token>'
Example Responses
No example specified for this content type

Add Document

PUT
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/documents

This endpoint adds document to the task.

Add Document › path Parameters

task_id
​string · required

Enter task id

Add Document › Request Body

string

Add Document › Responses

Success Response

UpdateTaskResponse
message
​string · required

Success message

PUT/api/v1.0/tasks/{task_id}/documents
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/documents \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data 'string'
Example Request Body
string
json
Example Responses
{ "message": "message" }
json
application/json

Clone Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/{task_id}/clone

This endpoint creates clone copy of the task.

Clone Task › path Parameters

task_id
​string · required

Enter task id

Clone Task › Request Body

string

Clone Task › Responses

The resource created successfully

UpdateTaskResponse
message
​string · required

Success message

POST/api/v1.0/tasks/{task_id}/clone
curl https://openapi.niftypm.com/api/v1.0/tasks/:task_id/clone \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data 'string'
Example Request Body
string
json
Example Responses
{ "message": "message" }
json
application/json

Move Task

POST
https://openapi.niftypm.com
/api/v1.0/tasks/move

This endpoint moves the task.

Move Task › Request Body

MoveTasks
​object · required
task_ids
​string[] · required

List of Task ID

Move Task › Responses

The resource created successfully

No data returned
POST/api/v1.0/tasks/move
curl https://openapi.niftypm.com/api/v1.0/tasks/move \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "to": { "type": "type", "id": "id" }, "task_ids": [ "string" ] }'
Example Request Body
{ "to": { "type": "type", "id": "id" }, "task_ids": [ "string" ] }
json
Example Responses
No example specified for this content type

PortfoliosStatus