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

Milestones & Lists


Get Milestones

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

This endpoint fetch the list of milestones.

Get Milestones › query Parameters

project_id
​string · required

Project ID

limit
​string

No of records per page

Example: 25
offset
​string

Record Offset

Example: 0
sort
​string · enum

Sorting order, default is descending

Enum values:
ascending
descending
is_list
​string

List Flag

Get Milestones › Responses

Success Response

GetMilestonesReponse
hasMore
​boolean · required

True if there are more record else false

Default: false
​MilestoneShortView[] · required

List of Label records

GET/api/v1.0/milestones
curl 'https://openapi.niftypm.com/api/v1.0/milestones?project_id=<string>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "hasMore": false, "items": [ { "id": "id", "name": "name", "created_at": "2024-08-25T15:00:00Z", "created_by": "created_by", "description": "description", "dependency": "dependency", "start": "2024-08-25T15:00:00Z", "end": "2024-08-25T15:00:00Z", "archived": "archived", "project": "project", "task_group": "task_group", "rule": "rule", "tasks": [ "string" ], "hidden": [ "string" ], "fields": [ { "id": "id", "value": "value" } ], "statistic": { "total": 0, "completed": 0, "overdue": 0, "total_story_points": 0, "completed_story_points": 0 }, "order": 0, "color": "color", "is_list": true, "assignees": [ "string" ] } ] }
json
application/json

Create Milestone

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

This endpoint creates the milestone.

Create Milestone › Request Body

CreateMilestone
project_id
​string · required

Project ID

name
​string · required

Milestone name

description
​string · required

Milestone Description

task_group_id
​string

Task Group ID

dependency
​string

Milestone dependency

start
​string

Milestone start date

end
​string

Milestone end date

rule_id
​string

Milestone rule id

hidden
​string[]

Hidden

isTaskGroup
​boolean

Is Task Group?

is_list
​boolean

List Flag

Create Milestone › Responses

The resource created successfully

MilestoneReponse
message
​string · required

Success message

id
​string · required

Created Label ID

POST/api/v1.0/milestones
curl https://openapi.niftypm.com/api/v1.0/milestones \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "project_id": "project_id", "task_group_id": "task_group_id", "name": "name", "description": "description", "dependency": "dependency", "start": "start", "end": "end", "rule_id": "rule_id", "hidden": [ "string" ], "isTaskGroup": true, "is_list": true }'
Example Request Body
{ "project_id": "project_id", "task_group_id": "task_group_id", "name": "name", "description": "description", "dependency": "dependency", "start": "start", "end": "end", "rule_id": "rule_id", "hidden": [ "string" ], "isTaskGroup": true, "is_list": true }
json
Example Responses
{ "message": "message", "id": "id" }
json
application/json

Get Milestone

GET
https://openapi.niftypm.com
/api/v1.0/milestones/{milestone_id}

This endpoint fetch the milestone information.

Get Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Get Milestone › Responses

Success Response

MilestoneShortView
id
​string · required

Milestone ID

name
​string · required

Milestone Name

created_at
​string · date-time · required

Creation Date

created_by
​string · required

Operation message

description
​string · required

Description

dependency
​string · required

Dependencies

start
​string · date-time · required

Start Date

end
​string · date-time · required

End Date

archived
​string · required

achived

project
​string · required

Project

task_group
​string · required

Task Group

rule
​string · required

Rules

tasks
​string[] · required

List of Tasks

hidden
​string[] · required

hidden

​AttachedCustomFieldResponse[] · required
​TasksStatistic · required
order
​number · required

Order

color
​string · required

Color

is_list
​boolean · required

List Flag

assignees
​string[] · required

Assignee to List

GET/api/v1.0/milestones/{milestone_id}
curl https://openapi.niftypm.com/api/v1.0/milestones/:milestone_id \ --header 'Authorization: Bearer <token>'
Example Responses
{ "id": "id", "name": "name", "created_at": "2024-08-25T15:00:00Z", "created_by": "created_by", "description": "description", "dependency": "dependency", "start": "2024-08-25T15:00:00Z", "end": "2024-08-25T15:00:00Z", "archived": "archived", "project": "project", "task_group": "task_group", "rule": "rule", "tasks": [ "string" ], "hidden": [ "string" ], "fields": [ { "id": "id", "value": "value" } ], "statistic": { "total": 0, "completed": 0, "overdue": 0, "total_story_points": 0, "completed_story_points": 0 }, "order": 0, "color": "color", "is_list": true, "assignees": [ "string" ] }
json
application/json

Update Milestone

PUT
https://openapi.niftypm.com
/api/v1.0/milestones/{milestone_id}

This endpoint updates the milestone details.

Update Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Update Milestone › Request Body

UpdateMilestoneDto
name
​string

Milestone name

description
​string

Milestone description

dependency
​string

Milestone dependencies

start
​string

Milestone start date

end
​string

Milestone end date

rollup
​string

Milestone rollup

is_list
​boolean

List Flag

Update Milestone › Responses

Success Response

UpdateMilestoneResponse
message
​string · required

Success message

PUT/api/v1.0/milestones/{milestone_id}
curl https://openapi.niftypm.com/api/v1.0/milestones/:milestone_id \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "name", "description": "description", "dependency": "dependency", "start": "start", "end": "end", "rollup": "rollup", "is_list": true }'
Example Request Body
{ "name": "name", "description": "description", "dependency": "dependency", "start": "start", "end": "end", "rollup": "rollup", "is_list": true }
json
Example Responses
{ "message": "message" }
json
application/json

Remove Milestone

DELETE
https://openapi.niftypm.com
/api/v1.0/milestones/{milestone_id}

This endpoint removes the milestone.

Remove Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Remove Milestone › Responses

Success Response

UpdateMilestoneResponse
message
​string · required

Success message

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

Move Milestone

PUT
https://openapi.niftypm.com
/api/v1.0/milestones/{milestone_id}/move_to_project

This endpoint moves the milestone to the project.

Move Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Move Milestone › Request Body

MoveToProjectMilestoneDto
project_id
​string · required

Project ID

Move Milestone › Responses

Success Response

UpdateMilestoneResponse
message
​string · required

Success message

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

Tie Task To Milestone

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

This endpoint adds the list of tasks to the milestone.

Tie Task To Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Tie Task To Milestone › Request Body

UpdateTasks
tasks
​string[] · required

List of Tasks ID

Tie Task To Milestone › Responses

Success Response

MilestoneTasksResponse
message
​string · required

Success message

tasks
​string[] · required

List of tasks

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

Remove Milestone Task

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

This endpoint removes the list of task from the milestone.

Remove Milestone Task › path Parameters

milestone_id
​string · required

Milestone ID

Remove Milestone Task › Request Body

UpdateTasks
tasks
​string[] · required

List of Tasks ID

Remove Milestone Task › Responses

Success Response

MilestoneTasksResponse
message
​string · required

Success message

tasks
​string[] · required

List of tasks

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

Archive Milestone

POST
https://openapi.niftypm.com
/api/v1.0/milestones/{milestone_id}/archive

This endpoint archives the milestone details.

Archive Milestone › path Parameters

milestone_id
​string · required

Milestone ID

Archive Milestone › Request Body

UpdateStatus
archived
​boolean · required

Archived

tasks
​boolean

Task Flag

Archive Milestone › Responses

UpdateMilestoneResponse
message
​string · required

Success message

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

MessagesProjects