Projects

Get Projects

GET

https://openapi.niftypm.com

/api/v1.0/projects

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

Get Projects › query Parameters

subteam_id

string

Subteam ID

archived

string

Archived : true or false

limit

string

No of records to fetch

Example: 25

offset

string

Record Offset

Example: 0

sort

string · enum

Sorting order, default is ascending

Enum values:

ascending

descending

Get Projects › Responses

Success Response

GetProjectsReponses

ProjectResponse[] · required

List of Projects

hasMore

boolean · required

True if there are more record else false

Default: false

GET/api/v1.0/projects

curl https://openapi.niftypm.com/api/v1.0/projects \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "items": [
    {
      "id": "id",
      "nice_id": "nice_id",
      "name": "name",
      "description": "description",
      "initials": "initials",
      "logo": "logo",
      "color": "color",
      "secondary_color": "secondary_color",
      "demo": true,
      "archived": true,
      "auto_milestones": true,
      "default_tasks_view": "default_tasks_view",
      "access_type": "access_type",
      "owner": "owner",
      "members": [
        "string"
      ],
      "general_discussion": "general_discussion",
      "subteam": "subteam",
      "progress": 0,
      "joined": true,
      "general_discussion_muted": true,
      "email": "email",
      "zoom_id": "zoom_id",
      "zoom_password": "zoom_password",
      "zoom_join_url": "zoom_join_url",
      "webex_id": "webex_id",
      "webex_password": "webex_password",
      "webex_join_url": "webex_join_url",
      "enabled_modules": [
        "string"
      ],
      "disabled_modules": [
        "string"
      ],
      "disabled_widgets": 0,
      "hidden_taskboard_fields": 0,
      "repo": "repo",
      "total_story_points": 0,
      "completed_story_points": 0,
      "pinned_message": "pinned_message",
      "pinned_by": "pinned_by",
      "completion_groups": [
        "string"
      ],
      "doc_root_folder": {},
      "file_root_folder": {},
      "removed": true,
      "rollups": [
        "string"
      ],
      "list_columns_order": [
        "string"
      ],
      "hidden_list_columns": [
        "string"
      ],
      "integrations": [
        "string"
      ]
    }
  ],
  "hasMore": false
}

json

application/json

Create Project

POST

https://openapi.niftypm.com

/api/v1.0/projects

This endpoint creates the project details.

Create Project › Request Body

CreateProjectDto

name

string · required

Name

subteam_id

string

Subteam ID

description

string

Description

demo

boolean

Demo

template_id

string

Template ID

nice_id

string

Nice ID

access_type

string

Access Type

project_type

string

Project Type

default_tasks_view

string

Default Task View

disabled

string[]

Disabled

Create Project › Responses

The resource created successfully

ProjectResponse

id

string · required

nice_id

string · required

name

string · required

description

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

demo

boolean · required

archived

boolean · required

auto_milestones

boolean · required

default_tasks_view

string · required

access_type

string · required

owner

string · required

members

string[] · required

general_discussion

string · required

subteam

string · required

progress

number · required

joined

boolean · required

general_discussion_muted

boolean · required

email

string · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

enabled_modules

string[] · required

disabled_modules

string[] · required

disabled_widgets

number · enum · required

Enum values:

hidden_taskboard_fields

number · enum · required

Enum values:

repo

string · required

total_story_points

number · required

completed_story_points

number · required

pinned_message

string · required

pinned_by

string · required

completion_groups

string[] · required

doc_root_folder

object · required

file_root_folder

object · required

removed

boolean · required

rollups

string[] · required

list_columns_order

string[] · required

hidden_list_columns

string[] · required

integrations

string[] · required

Integration details

POST/api/v1.0/projects

curl https://openapi.niftypm.com/api/v1.0/projects \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "subteam_id": "subteam_id",
  "name": "name",
  "description": "description",
  "demo": true,
  "template_id": "template_id",
  "nice_id": "nice_id",
  "access_type": "access_type",
  "project_type": "project_type",
  "default_tasks_view": "default_tasks_view",
  "disabled": [
    "string"
  ]
}'

Example Request Body

{
  "subteam_id": "subteam_id",
  "name": "name",
  "description": "description",
  "demo": true,
  "template_id": "template_id",
  "nice_id": "nice_id",
  "access_type": "access_type",
  "project_type": "project_type",
  "default_tasks_view": "default_tasks_view",
  "disabled": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "nice_id": "nice_id",
  "name": "name",
  "description": "description",
  "initials": "initials",
  "logo": "logo",
  "color": "color",
  "secondary_color": "secondary_color",
  "demo": true,
  "archived": true,
  "auto_milestones": true,
  "default_tasks_view": "default_tasks_view",
  "access_type": "access_type",
  "owner": "owner",
  "members": [
    "string"
  ],
  "general_discussion": "general_discussion",
  "subteam": "subteam",
  "progress": 0,
  "joined": true,
  "general_discussion_muted": true,
  "email": "email",
  "zoom_id": "zoom_id",
  "zoom_password": "zoom_password",
  "zoom_join_url": "zoom_join_url",
  "webex_id": "webex_id",
  "webex_password": "webex_password",
  "webex_join_url": "webex_join_url",
  "enabled_modules": [
    "string"
  ],
  "disabled_modules": [
    "string"
  ],
  "disabled_widgets": 0,
  "hidden_taskboard_fields": 0,
  "repo": "repo",
  "total_story_points": 0,
  "completed_story_points": 0,
  "pinned_message": "pinned_message",
  "pinned_by": "pinned_by",
  "completion_groups": [
    "string"
  ],
  "doc_root_folder": {},
  "file_root_folder": {},
  "removed": true,
  "rollups": [
    "string"
  ],
  "list_columns_order": [
    "string"
  ],
  "hidden_list_columns": [
    "string"
  ],
  "integrations": [
    "string"
  ]
}

json

application/json

Get Project

GET

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}

This endpoint fetch the project details.

Get Project › path Parameters

project_id

string · required

Enter project id

Get Project › Responses

Success Response

ProjectResponse

id

string · required

nice_id

string · required

name

string · required

description

string · required

initials

string · required

logo

string · required

color

string · required

secondary_color

string · required

demo

boolean · required

archived

boolean · required

auto_milestones

boolean · required

default_tasks_view

string · required

access_type

string · required

owner

string · required

members

string[] · required

general_discussion

string · required

subteam

string · required

progress

number · required

joined

boolean · required

general_discussion_muted

boolean · required

email

string · required

zoom_id

string · required

zoom_password

string · required

zoom_join_url

string · required

webex_id

string · required

webex_password

string · required

webex_join_url

string · required

enabled_modules

string[] · required

disabled_modules

string[] · required

disabled_widgets

number · enum · required

Enum values:

hidden_taskboard_fields

number · enum · required

Enum values:

repo

string · required

total_story_points

number · required

completed_story_points

number · required

pinned_message

string · required

pinned_by

string · required

completion_groups

string[] · required

doc_root_folder

object · required

file_root_folder

object · required

removed

boolean · required

rollups

string[] · required

list_columns_order

string[] · required

hidden_list_columns

string[] · required

integrations

string[] · required

Integration details

GET/api/v1.0/projects/{project_id}

curl https://openapi.niftypm.com/api/v1.0/projects/:project_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "nice_id": "nice_id",
  "name": "name",
  "description": "description",
  "initials": "initials",
  "logo": "logo",
  "color": "color",
  "secondary_color": "secondary_color",
  "demo": true,
  "archived": true,
  "auto_milestones": true,
  "default_tasks_view": "default_tasks_view",
  "access_type": "access_type",
  "owner": "owner",
  "members": [
    "string"
  ],
  "general_discussion": "general_discussion",
  "subteam": "subteam",
  "progress": 0,
  "joined": true,
  "general_discussion_muted": true,
  "email": "email",
  "zoom_id": "zoom_id",
  "zoom_password": "zoom_password",
  "zoom_join_url": "zoom_join_url",
  "webex_id": "webex_id",
  "webex_password": "webex_password",
  "webex_join_url": "webex_join_url",
  "enabled_modules": [
    "string"
  ],
  "disabled_modules": [
    "string"
  ],
  "disabled_widgets": 0,
  "hidden_taskboard_fields": 0,
  "repo": "repo",
  "total_story_points": 0,
  "completed_story_points": 0,
  "pinned_message": "pinned_message",
  "pinned_by": "pinned_by",
  "completion_groups": [
    "string"
  ],
  "doc_root_folder": {},
  "file_root_folder": {},
  "removed": true,
  "rollups": [
    "string"
  ],
  "list_columns_order": [
    "string"
  ],
  "hidden_list_columns": [
    "string"
  ],
  "integrations": [
    "string"
  ]
}

json

application/json

Update Project

PUT

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}

This endpoint updates the project details.

Update Project › path Parameters

project_id

string · required

Enter project id

Update Project › Request Body

UploadedFileS3

Update Project › Responses

Success Response

GeneralProjectReponse

message

string · required

Success message

id

string · required

Created ID

Remove Project

DELETE

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}

This endpoint removes the project details.

Remove Project › path Parameters

project_id

string · required

Enter project id

Remove Project › Responses

The record has been updated successfully.

DeleteProjectReponse

message

string · required

Success message

Invite Team Member for project

POST

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/invite

This endpoint sends invitation details to the team member.

Invite Team Member for project › path Parameters

project_id

string · required

Enter project id

Invite Team Member for project › Request Body

InviteProjectDto

InviteProjectMember[] · required

Invitees

Invite Team Member for project › Responses

The resource created successfully

ProjectInviteResponse

message

string · required

Operation message

object[] · required

Invited

Leave Project

POST

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/leave

This endpoint use to leave the project by team member.

Leave Project › path Parameters

project_id

string · required

Enter project id

Leave Project › Responses

The resource created successfully

LeaveProjectReponse

message

string · required

Success message

member_id

string · required

Member ID

Start Project

POST

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/start

This endpoint marks the project as start state.

Start Project › path Parameters

project_id

string · required

Enter project id

Start Project › Responses

The resource created successfully

No data returned

Get Project Custom Fields

GET

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/fields

This endpoint fetch the custom fields for the project.

Get Project Custom Fields › path Parameters

project_id

string · required

Enter project id

Get Project Custom Fields › query Parameters

Project ID

string

If project_id parameter is not passed it will return team level all the custom fields.

limit

string

No of records per page

Example: 25

offset

string

Record Offset

Example: 0

Get Project Custom Fields › Responses

Success Response

AttachedCustomFieldResponse[]

AttachedCustomFieldResponse

id

string · required

value

string · required

Value

Add Project Custom Fields

POST

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/fields

This endpoint creates the custom fields for the project.

Add Project Custom Fields › Request Body

CreateCustomField

name

string · required

Custom field name

type

number · enum · required

Custom field type

Enum values:

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:

cost_per_hour

number

Cost per hour

save

boolean

Save

association

string

Association

project_id

string

Project ID

Add Project Custom Fields › Responses

The resource created successfully

No data returned

POST/api/v1.0/projects/{project_id}/fields

curl https://openapi.niftypm.com/api/v1.0/projects/:project_id/fields \
  --request POST \
  --header 'Content-Type: application/json' \
  --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 Project Custom Fields

PUT

https://openapi.niftypm.com

/api/v1.0/projects/{project_id}/fields/{field_id}

This endpoint update the custom fields details for the project.

Update Project Custom Fields › path Parameters

project_id

string · required

Enter project id

field_id

string · required

Enter field id

Update Project Custom Fields › Responses

Success Response

No data returned

Milestones & Lists Portfolios