Bearer (http)
Send a bearer token
(“JWT” Formatted)
in the Authorization
http header
to authenticate with the API.
Hello and welcome! We're excited to have you build your own integrations and Nifty apps with our REST API documentation.
The lefthand sidebar will allow you to navigate to the Authentication section as well as explore our Endpoints section. Each Endpoint has an example Request and Response to help you understand how to leverage the call.
We apply request rate limits per token to make sure the API runs efficiently for everyone.
GET: 200 requests per minute
POST: 50 requests per minute
PUT: 50 requests per minute
DELETE: 10 requests per minute
Get started in the Authentication section of the document. Please note that our API is available to customers on the Business Plan and above. Contact team@niftypm.com if you're a third party tool looking to partner and build an integration with Nifty.
You can try our API using Swagger.
Before you start with the documentation, check our help article and create your app in Nifty.
This is the documentation for version 1.0
of the API. Last update on Feb 13, 2023.
https://openapi.niftypm.com
Send a bearer token
(“JWT” Formatted)
in the Authorization
http header
to authenticate with the API.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/apps?limit=25&offset=0 \
-H "Authorization: Bearer $ACCESS_TOKEN"
[]
Enter app id
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/apps/{appId} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"logo": "string",
"redirect_urls": "string",
"description": "string",
"scopes": "file",
"created_by": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"updated_at": "2023-05-04T09:42:00+00:00"
}
This endpoint is used to generate refresh token using parameters client_id, code and client_secret.
If Grant type is "authorization_code" then request body must have two mandatory parameters, called "code" and "redirect_uri".
While generating new access token on expiry, request body must have grant type as "refresh_token" and mandatory parameter called "refresh_token".
Code will be come from the authorize url call back redirect url.
Refresh Token
grant_type
Values are authorization_code
or refresh_token
.
Redirect URI
Generate required refresh and access tokens.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/oauth/token \
-H "Content-Type: application/json" \
-H "authorization: string" \
-d '{"code":"Pk6DnFY4q9Z1X7aOQATV5z4bxg1rjwH4","refresh_token":["string"],"grant_type":"authorization_code","redirect_uri":["string"]}'
# Headers
authorization: string
# Payload
{
"code": "Pk6DnFY4q9Z1X7aOQATV5z4bxg1rjwH4",
"refresh_token": [
"string"
],
"grant_type": "authorization_code",
"redirect_uri": [
"string"
]
}
{
"access_token": "string",
"token_type": "string",
"refresh_token": "string",
"expires_in": 42.0,
"scope": "file"
}
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/chats \
-H "Authorization: Bearer $ACCESS_TOKEN"
This endpoint fetch the details for chat based on given chat id.
Chat id
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/chats/{chat_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"type": "string",
"description": "string",
"team": "string",
"project": "string",
"is_self": true,
"members": {
"id": "string",
"is_owner": true,
"is_muted": true,
"joined": true
},
"created_at": "2023-05-04T09:42:00+00:00",
"last_message_at": "2023-05-04T09:42:00+00:00",
"zoom_id": "string",
"zoom_password": "string",
"zoom_join_url": "string",
"webex_id": "string",
"webex_password": "string",
"webex_join_url": "string",
"pinned_message": "string",
"pinned_by": "string",
"meeting_type": "string"
}
This endpoint fetch lsit of all the documents based on given query parameters.
Project ID
Task ID
Parent Document ID
No of records per page
Record Offset
Folder ID
Document Name
Document Tag
Sorting order, default is descending
Values are ascending
or descending
.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/docs?project_id=string&task_id=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"items": [
{
"id": "string",
"name": "string",
"access_type": "string",
"type": "string",
"subtype": "string",
"external_id": "string",
"content": {},
"author": "string",
"project_id": "string",
"tasks": [
"string"
],
"archived": true,
"members": [
{
"id": "string",
"permission": "string",
"is_author": true,
"active": true,
"last_seen": "2023-05-04T09:42:00+00:00",
"last_edited": "2023-05-04T09:42:00+00:00"
}
],
"discussion_keys": [
"string"
],
"public_token": "string",
"share_token": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"comments": 42.0,
"hasAccess": true,
"labels": [
"string"
],
"folder": "string",
"order": 42.0,
"multipage": true,
"parent_doc_id": "string"
}
],
"hasMore": false
}
Name
Parent Document ID
Project ID
Google Access Token
Type of Document
Subtype of the document
Private Flag
Values are 0
, 1
, or 2
.
Document Content
External ID
Folder ID
Folder stack
Document Order
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/docs \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","parent_doc_id":"string","project_id":"string","googleAccessToken":"string","type":"string","subtype":"string","private":true,"access_type":0,"content":{},"external_id":"string","folder_id":"string","folder_stack":["string"],"order":42.0}'
{
"name": "string",
"parent_doc_id": "string",
"project_id": "string",
"googleAccessToken": "string",
"type": "string",
"subtype": "string",
"private": true,
"access_type": 0,
"content": {},
"external_id": "string",
"folder_id": "string",
"folder_stack": [
"string"
],
"order": 42.0
}
{
"message": "string",
"doc_id": "string",
"folder": "string"
}
This endpoint fetch lsit of all the personal documents based on given query parameters.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/docs/personal \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"items": [
{
"id": "string",
"name": "string",
"access_type": "string",
"type": "string",
"subtype": "string",
"external_id": "string",
"content": {},
"author": "string",
"project_id": "string",
"tasks": [
"string"
],
"archived": true,
"members": [
{
"id": "string",
"permission": "string",
"is_author": true,
"active": true,
"last_seen": "2023-05-04T09:42:00+00:00",
"last_edited": "2023-05-04T09:42:00+00:00"
}
],
"discussion_keys": [
"string"
],
"public_token": "string",
"share_token": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"comments": 42.0,
"hasAccess": true,
"labels": [
"string"
],
"folder": "string",
"order": 42.0,
"multipage": true,
"parent_doc_id": "string"
}
],
"hasMore": false
}
This endpoint creates a new personal document based on given request data.
Name
Parent Document ID
Project ID
Google Access Token
Type of Document
Subtype of the document
Private Flag
Values are 0
, 1
, or 2
.
Document Content
External ID
Folder ID
Folder stack
Document Order
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/docs/personal \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","parent_doc_id":"string","project_id":"string","googleAccessToken":"string","type":"string","subtype":"string","private":true,"access_type":0,"content":{},"external_id":"string","folder_id":"string","folder_stack":["string"],"order":42.0}'
{
"name": "string",
"parent_doc_id": "string",
"project_id": "string",
"googleAccessToken": "string",
"type": "string",
"subtype": "string",
"private": true,
"access_type": 0,
"content": {},
"external_id": "string",
"folder_id": "string",
"folder_stack": [
"string"
],
"order": 42.0
}
{
"message": "string",
"doc_id": "string"
}
This endpoint fetch a particular document based on document id.
Document ID
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/docs/{document_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"access_type": "string",
"type": "string",
"subtype": "string",
"external_id": "string",
"content": {},
"author": "string",
"project_id": "string",
"tasks": [
"string"
],
"archived": true,
"members": [
{
"id": "string",
"permission": "string",
"is_author": true,
"active": true,
"last_seen": "2023-05-04T09:42:00+00:00",
"last_edited": "2023-05-04T09:42:00+00:00"
}
],
"discussion_keys": [
"string"
],
"public_token": "string",
"share_token": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"comments": 42.0,
"hasAccess": true,
"labels": [
"string"
],
"folder": "string",
"order": 42.0,
"multipage": true,
"parent_doc_id": "string"
}
This endpoint updates document using unique document id with given data.
Document ID
Document name
Archived
Values are 0
, 1
, or 2
.
Force Flag
Folder ID
Folder path stack
Is Multiple page?
Document Order
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/docs/{document_id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","archived":true,"access_type":0,"force":true,"content":{},"folder_id":"string","folder_stack":["string"],"multipage":true,"order":42.0}'
{
"name": "string",
"archived": true,
"access_type": 0,
"force": true,
"content": {},
"folder_id": "string",
"folder_stack": [
"string"
],
"multipage": true,
"order": 42.0
}
{
"message": "string",
"doc_id": "string"
}
This endpoint removes a document using unique identifier id.
Document ID
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/docs/{document_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string"
}
This endpoint moves a document into another project folder.
Document ID
Folder ID
Folder stack of document path
Project ID associated with the document
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/docs/{document_id}/move_to_project \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"folder_id":"string","folder_stack":"string","project_id":"string"}'
{
"folder_id": "string",
"folder_stack": "string",
"project_id": "string"
}
{
"message": "string",
"doc_id": "string"
}
This endpoint updates document's members list
Document ID
Document Invitee details
Folder stack
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/docs/{document_id}/members \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"members":[{"id":"string","permission":0}],"folder_stack":["string"]}'
{
"members": [
{
"id": "string",
"permission": 0
}
],
"folder_stack": [
"string"
]
}
{
"message": "string",
"added_members": [
"string"
],
"updated_members": [
"string"
]
}
This endpoint removes member from given document.
Document ID
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/docs/{document_id}/members \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"members":["string"]}'
{
"members": [
"string"
]
}
{
"message": "string",
"members_id": [
"string"
]
}
Document ID
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/docs/{document_id}/change \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"success": true
}
This endpoint updates the labels for the document.
Document ID
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/docs/{document_id}/labels \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"labels":["string"]}'
{
"labels": [
"string"
]
}
{
"message": "string",
"labels": [
"string"
]
}
This endpoint removes labels from the document.
Document ID
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/docs/{document_id}/labels \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"labels":["string"]}'
{
"labels": [
"string"
]
}
{
"message": "string",
"labels": [
"string"
]
}
This endpoint fetch list of files based on the given query parameters.
Project ID
Task ID
Document ID
User ID
Type
No of records per page
Record Offset
Folder ID
File Name
Group
Tag
Sorting order, default is descending
Values are ascending
or descending
.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/files?project_id=string&task_id=string&doc_id=string&user_id=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"hasMore": false,
"files": [
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true,
"task": "string",
"project_id": "string",
"message": "string",
"labels": [
"string"
],
"folder": "string",
"folder_stack": [
"string"
],
"document": "string",
"annotations_task_id": "string"
}
]
}
Project ID
Task ID
Document ID
Folder ID
Folder stack
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/files?project_id=string&task_id=string&doc_id=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string",
"files": [
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true,
"task": "string",
"project_id": "string",
"message": "string",
"labels": [
"string"
],
"folder": "string",
"folder_stack": [
"string"
],
"document": "string",
"annotations_task_id": "string"
}
]
}
This endpoint fetch the details of the file based on unique file identified
File ID
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/files/{file_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true,
"task": "string",
"project_id": "string",
"message": "string",
"labels": [
"string"
],
"folder": "string",
"folder_stack": [
"string"
],
"document": "string",
"annotations_task_id": "string"
}
File ID
Folder ID
Folder stack
Annotations Task ID
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/files/{file_id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"folder_id":"string","folder_stack":["string"],"annotations_task_id":"string"}'
{
"folder_id": "string",
"folder_stack": [
"string"
],
"annotations_task_id": "string"
}
{
"message": "string",
"file_id": "string"
}
This endpoint removes the file using the unique file idetifier.
File ID
Success Response
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/files/{file_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string",
"id": "string"
}
{
"message": "string",
"id": "string"
}
File ID
Task ID associated with the file
Message ID associated with the file
Project ID associated with the file
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/files/{file_id}/copy \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"task_id":"string","message_id":"string","project_id":"string"}'
{
"task_id": "string",
"message_id": "string",
"project_id": "string"
}
File ID
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/files/{file_id}/labels \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"labels":["string"]}'
{
"labels": [
"string"
]
}
{
"message": "string",
"labels": [
"string"
]
}
This endpoint remove the labels from the file.
File ID
Success Response
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/files/{file_id}/labels \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"labels":["string"]}'
{
"labels": [
"string"
]
}
{
"message": "string",
"labels": [
"string"
]
}
{
"message": "string",
"labels": [
"string"
]
}
Project ID
Role
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/invites \
-H "Authorization: Bearer $ACCESS_TOKEN"
This endpoint fetch list of all the label based on given query parameters.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/labels \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"hasMore": false,
"items": [
{
"id": "string",
"name": "string",
"color": "string",
"type": "string",
"created_by": "string",
"team": "string",
"default": "string"
}
]
}
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/labels \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","color":"string","type":0}'
{
"name": "string",
"color": "string",
"type": 0
}
{
"message": "string",
"id": "string"
}
This endpoint fetch the label details using unique label_id.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/labels/{label_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"color": "string",
"type": "string",
"created_by": "string",
"team": "string",
"default": "string"
}
This endpoint update the label details using unique label_id.
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/labels/{label_id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","color":"string"}'
{
"name": "string",
"color": "string"
}
{
"message": "string",
"id": "string"
}
This endpoint removes the label using unique label_id.
Success Response
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/labels/{label_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string",
"id": "string"
}
{
"message": "string",
"id": "string"
}
Chat ID
Message ID
Task ID
File ID
Document ID
Entity Key
No of records per page
Record Offset
Before ID
After ID
Before Date
After Date
Annotation ID
Type
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/messages \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"messages": [
{
"id": "string",
"type": "string",
"hide_link_preview": true,
"subtype": "string",
"text": "string",
"url": "string",
"chat": "string",
"thread": "string",
"task": "string",
"file": "string",
"document": "string",
"entity_key": "string",
"author": "string",
"replies": 42.0,
"repliers": [
"string"
],
"tagged": [
"string"
],
"seen_by": [
"string"
],
"hidden": [
"string"
],
"doc_attachment": "string",
"attachments": [
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true
}
],
"is_edited": true,
"is_deleted": true,
"created_at": "2023-05-04T09:42:00+00:00",
"updated_at": "2023-05-04T09:42:00+00:00",
"annotation_id": "string",
"heardBy": [
"string"
],
"audio_duration": 42.0,
"heard": true
}
],
"has_more": true
}
Message Type
Message Text
URL
Document Attachment
Entity Key
Chat ID
Message ID
Task ID
File ID
Document ID
Task Details
List of External files
List of Nifty Files
Date
BOT Name
BOT Avtar
Emails
Annotation ID
Context Text
Audion Duration
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/messages \
-H "Content-Type: application/json" \
-d '{"type":"string","text":"string","url":"string","doc_attachment":"string","entity_key":"string","chat_id":"string","message_id":"string","task_id":"string","file_id":"string","doc_id":"string","task":{},"external_files":["string"],"nifty_files":["string"],"date":"2023-05-04T09:42:00+00:00","bot_name":"string","bot_avatar":"string","hidden":["string"],"emails":"string","annotation_id":"string","context_text":"string","audio_duration":"string"}'
{
"type": "string",
"text": "string",
"url": "string",
"doc_attachment": "string",
"entity_key": "string",
"chat_id": "string",
"message_id": "string",
"task_id": "string",
"file_id": "string",
"doc_id": "string",
"task": {},
"external_files": [
"string"
],
"nifty_files": [
"string"
],
"date": "2023-05-04T09:42:00+00:00",
"bot_name": "string",
"bot_avatar": "string",
"hidden": [
"string"
],
"emails": "string",
"annotation_id": "string",
"context_text": "string",
"audio_duration": "string"
}
{
"message": "string",
"data": {}
}
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/messages/{message_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"type": "string",
"hide_link_preview": true,
"subtype": "string",
"text": "string",
"url": "string",
"chat": "string",
"thread": "string",
"task": "string",
"file": "string",
"document": "string",
"entity_key": "string",
"author": "string",
"replies": 42.0,
"repliers": [
"string"
],
"tagged": [
"string"
],
"seen_by": [
"string"
],
"hidden": [
"string"
],
"doc_attachment": "string",
"attachments": [
{
"id": "string",
"name": "string",
"size": 42.0,
"url": "string",
"download": "string",
"thumbnail": "string",
"uploader": "string",
"comments": 42.0,
"created_at": "2023-05-04T09:42:00+00:00",
"googleId": "string",
"googleType": "string",
"processed": true
}
],
"is_edited": true,
"is_deleted": true,
"created_at": "2023-05-04T09:42:00+00:00",
"updated_at": "2023-05-04T09:42:00+00:00",
"annotation_id": "string",
"heardBy": [
"string"
],
"audio_duration": 42.0,
"heard": true
}
Message ID
Message Text
List of External Files
Hide link preview
List of Nifty Files
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/messages/{message_id} \
-H "Content-Type: application/json" \
-d '{"text":"string","external_files":[{}],"hide_link_preview":true,"nifty_files":["string"]}'
{
"text": "string",
"external_files": [
{}
],
"hide_link_preview": true,
"nifty_files": [
"string"
]
}
Message ID
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/messages/{message_id}
{
"message_id": "string",
"message": "string"
}
This endpoint marks the message as seen by the member.
Message ID
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/messages/{message_id}/see
{
"message_ids": [
"string"
],
"message": "string"
}
This endpoint marks the message as heard by the member.
Message ID
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/messages/{message_id}/hear
{
"message_id": "string",
"message": "string"
}
Project ID
No of records per page
Record Offset
Sorting order, default is descending
Values are ascending
or descending
.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/milestones?project_id=string \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"hasMore": false,
"items": [
{
"id": "string",
"name": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"created_by": "string",
"description": "string",
"dependency": "string",
"start": "2023-05-04T09:42:00+00:00",
"end": "2023-05-04T09:42:00+00:00",
"archived": "string",
"project": "string",
"task_group": "string",
"rule": "string",
"tasks": [
"string"
],
"hidden": [
"string"
],
"fields": [
{
"id": "string",
"value": "string"
}
],
"statistic": {
"total": 42.0,
"completed": 42.0,
"overdue": 42.0,
"total_story_points": 42.0,
"completed_story_points": 42.0
}
}
]
}
Project ID
Task Group ID
Milestone name
Milestone Description
Milestone dependency
Milestone start date
Milestone end date
Milestone rule id
Is Task Group?
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/milestones \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"project_id":"string","task_group_id":"string","name":"string","description":"string","dependency":"string","start":"string","end":"string","rule_id":"string","hidden":["string"],"isTaskGroup":true}'
{
"project_id": "string",
"task_group_id": "string",
"name": "string",
"description": "string",
"dependency": "string",
"start": "string",
"end": "string",
"rule_id": "string",
"hidden": [
"string"
],
"isTaskGroup": true
}
{
"message": "string",
"id": "string"
}
This endpoint fetch the milestone information.
Milestone ID
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"created_at": "2023-05-04T09:42:00+00:00",
"created_by": "string",
"description": "string",
"dependency": "string",
"start": "2023-05-04T09:42:00+00:00",
"end": "2023-05-04T09:42:00+00:00",
"archived": "string",
"project": "string",
"task_group": "string",
"rule": "string",
"tasks": [
"string"
],
"hidden": [
"string"
],
"fields": [
{
"id": "string",
"value": "string"
}
],
"statistic": {
"total": 42.0,
"completed": 42.0,
"overdue": 42.0,
"total_story_points": 42.0,
"completed_story_points": 42.0
}
}
This endpoint updates the milestone details.
Milestone ID
Milestone name
Milestone description
Milestone dependencies
Milestone start date
Milestone end date
Milestone rollup
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","description":"string","dependency":"string","start":"string","end":"string","rollup":"string"}'
{
"name": "string",
"description": "string",
"dependency": "string",
"start": "string",
"end": "string",
"rollup": "string"
}
{
"message": "string"
}
Milestone ID
Success Response
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string"
}
{
"message": "string"
}
This endpoint moves the milestone to the project.
Milestone ID
Project ID
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id}/move_to_project \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"project_id":"string"}'
{
"project_id": "string"
}
{
"message": "string"
}
This endpoint adds the list of tasks to the milestone.
Milestone ID
Success Response
The record doesn't exist.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id}/tasks \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tasks":["string"]}'
{
"tasks": [
"string"
]
}
{
"message": "string",
"tasks": [
"string"
]
}
This endpoint removes the list of task from the milestone.
Milestone ID
Success Response
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id}/tasks \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"tasks":["string"]}'
{
"tasks": [
"string"
]
}
{
"message": "string",
"tasks": [
"string"
]
}
{
"message": "string",
"tasks": [
"string"
]
}
This endpoint archives the milestone details.
Milestone ID
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/milestones/{milestone_id}/archive \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"archived":true,"tasks":true}'
{
"archived": true,
"tasks": true
}
{
"message": "string"
}
{
"message": "string"
}
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/subteams \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"subteams": [
{
"id": "string",
"name": "string",
"initials": "string",
"logo": "string",
"color": "string",
"secondary_color": "string",
"is_general": true,
"owner": "string",
"members": [
"string"
]
}
],
"hasMore": false
}
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/subteams \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json"
{}
{
"message": "string",
"id": "string"
}
This endpoint fetch the prortfolio details using unique identifier id.
Enter sub team id
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"name": "string",
"initials": "string",
"logo": "string",
"color": "string",
"secondary_color": "string",
"is_general": true,
"owner": "string",
"members": [
"string"
]
}
This endpoint update the portfolio details using unique identifier id.
Enter subteam id
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id} \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json"
{}
{
"message": "string",
"id": "string"
}
This endpoint removes the portfolio using unique identifier id.
Enter subteam id
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id} \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string",
"id": "string"
}
This endpoint update the list of members in the portfolio.
Enter subteam id
List of Members ID
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X PUT https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id}/members \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"members_ids":["string"]}'
{
"members_ids": [
"string"
]
}
{
"message": "string",
"id": "string"
}
This endpoint removes the member from the portfolio.
Enter subteam id
List of Members ID
The record has been updated successfully.
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The record doesn't exist.
The request method is known by the server but is not supported by the target resource.
curl \
-X DELETE https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id}/members \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"members_ids":["string"]}'
{
"members_ids": [
"string"
]
}
{
"message": "string",
"id": "string"
}
This endpoint helps the member to leave from the portfolio.
Enter subteam id
The resource created successfully
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X POST https://openapi.niftypm.com/api/v1.0/subteams/{subteam_id}/leave \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"message": "string",
"id": "string"
}
Subteam ID
Archived : true or false
No of records to fetch
Record Offset
Sorting order, default is ascending
Values are ascending
or descending
.
Success Response
The client request has not been completed because it lacks valid authentication credentials for the requested resource.
The client does not have access rights to the content.
The request method is known by the server but is not supported by the target resource.
curl \
-X GET https://openapi.niftypm.com/api/v1.0/projects \
-H "Authorization: Bearer $ACCESS_TOKEN"
{
"projects": [
{
"id": "string",
"nice_id": "string",
"name": "string",
"description": "string",
"initials": "string",
"logo": "string",
"color": "string",
"secondary_color": "string",
"demo": true,
"archived": true,
"auto_milestones": true,
"default_tasks_view": "string",
"access_type": "string",
"owner": "string",
"members": [
"string"
],
"general_discussion": "string",
"subteam": "string",
"progress": 42.0,
"joined": true,
"general_discussion_muted": true,
"email": "string",
"zoom_id": "string",
"zoom_password": "string",
"zoom_join_url": "string",
"webex_id": "string",
"webex_password": "string",
"webex_join_url": "string",
"enabled_modules": [
"string"
],
"disabled_modules": [
"string"
],
"disabled_widgets": 0,
"hidden_taskboard_fields": 0,
"repo": "string",
"total_story_points": 42.0,
"completed_story_points": 42.0,
"pinned_message": "string",
"pinned_by": "string",
"completion_groups": [
"string"
],
"doc_root_folder": {},
"file_root_folder": {},
"removed": true,
"rollups": [
"string"
],
"list_columns_order": [
"string"
],
"hidden_list_columns": [
"string"
],
"integrations": [
"string"
]
}
],