Task

Download schema

A unit of work in a project. Carries name, description, status, assignees, labels, subscribers, due/start dates, parent task (for subtasks), list, archived flag, banner image and embed URL. Project-scoped — every task on this API lives inside a project, and the project is the security boundary; personal (project-less) tasks are not addressable here. Deletes are permanent: there is no trash or restore for a task. Setting assignees, labels or subscribers when you update a task replaces the whole set — use the matching sub-resource route, such as POST /tasks/{id}/assignees, to add or remove one at a time.

List Tasks

GET

https://openapi.niftypm.com/api/v3

/tasks

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

List tasks. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 22 fields. Ordered by order unless you pass sort.

Required scope: tasks:read

List Tasks › query Parameters

projectId

string

Restrict the list to one project. Omit to list tasks across every project you can access.

scope

string · enum

Which tasks a workspace-wide list returns: project (rows that belong to a project you can access), personal (your own rows, which belong to no project), or both. Ignored when you pass projectId. Default: both.

Enum values:

both

project

personal

sort

string · enum

Field to sort by. Prefix with - for descending (-createdAt); a createdAt:desc / createdAt:asc suffix works too, but never both markers at once. Default: order. Listing without projectId orders by -updatedAt instead.

Enum values:

name

niceId

order

orderList

startAt

dueAt

createdAt

updatedAt

cursor

string

Opaque cursor for the next page (the envelope nextCursor).

limit

integer · min: 1 · max: 200

Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.

Default: 50

includeTotal

boolean

When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.

expand

string[] · style: form

Comma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.

Enum values:

project

status

list

parentTask

dependency

recurringRule

createdBy

archivedBy

name[eq]

string

Filter where name equals.

name[contains]

string

Filter where name contains.

name[startsWith]

string

Filter where name starts with.

niceId[eq]

integer

Filter where niceId equals.

niceId[in]

integer[] · style: form

Filter where niceId is one of (comma-separated list).

archived[eq]

boolean

Filter where archived equals.

completed[eq]

boolean

Filter where completed equals.

projectId[eq]

string

Filter where projectId equals.

projectId[in]

string[] · style: form

Filter where projectId is one of (comma-separated list).

listId[eq]

string

Filter where listId equals.

listId[in]

string[] · style: form

Filter where listId is one of (comma-separated list).

statusId[eq]

string

Filter where statusId equals.

statusId[in]

string[] · style: form

Filter where statusId is one of (comma-separated list).

parentTaskId[eq]

string

Filter where parentTaskId equals.

parentTaskId[in]

string[] · style: form

Filter where parentTaskId is one of (comma-separated list).

dependencyId[eq]

string

Filter where dependencyId equals.

dependencyId[in]

string[] · style: form

Filter where dependencyId is one of (comma-separated list).

recurringRuleId[eq]

string

Filter where recurringRuleId equals.

recurringRuleId[in]

string[] · style: form

Filter where recurringRuleId is one of (comma-separated list).

createdById[eq]

string

Filter where createdById equals.

createdById[in]

string[] · style: form

Filter where createdById is one of (comma-separated list).

labelId[eq]

string

Filter where labelId equals.

labelId[in]

string[] · style: form

Filter where labelId is one of (comma-separated list).

assigneeId[eq]

string

Filter where assigneeId equals.

assigneeId[in]

string[] · style: form

Filter where assigneeId is one of (comma-separated list).

subscriberId[eq]

string

Filter where subscriberId equals.

subscriberId[in]

string[] · style: form

Filter where subscriberId is one of (comma-separated list).

createdByActorId[eq]

string

Filter where createdByActorId equals.

createdByActorId[in]

string[] · style: form

Filter where createdByActorId is one of (comma-separated list).

updatedByActorId[eq]

string

Filter where updatedByActorId equals.

updatedByActorId[in]

string[] · style: form

Filter where updatedByActorId is one of (comma-separated list).

startAt[gt]

string · date-time

Filter where startAt is greater than.

startAt[gte]

string · date-time

Filter where startAt is greater than or equal to.

startAt[lt]

string · date-time

Filter where startAt is less than.

startAt[lte]

string · date-time

Filter where startAt is less than or equal to.

dueAt[gt]

string · date-time

Filter where dueAt is greater than.

dueAt[gte]

string · date-time

Filter where dueAt is greater than or equal to.

dueAt[lt]

string · date-time

Filter where dueAt is less than.

dueAt[lte]

string · date-time

Filter where dueAt is less than or equal to.

completedAt[gt]

string · date-time

Filter where completedAt is greater than.

completedAt[gte]

string · date-time

Filter where completedAt is greater than or equal to.

completedAt[lt]

string · date-time

Filter where completedAt is less than.

completedAt[lte]

string · date-time

Filter where completedAt is less than or equal to.

archivedAt[gt]

string · date-time

Filter where archivedAt is greater than.

archivedAt[gte]

string · date-time

Filter where archivedAt is greater than or equal to.

archivedAt[lt]

string · date-time

Filter where archivedAt is less than.

archivedAt[lte]

string · date-time

Filter where archivedAt is less than or equal to.

createdAt[gt]

string · date-time

Filter where createdAt is greater than.

createdAt[gte]

string · date-time

Filter where createdAt is greater than or equal to.

createdAt[lt]

string · date-time

Filter where createdAt is less than.

createdAt[lte]

string · date-time

Filter where createdAt is less than or equal to.

updatedAt[gt]

string · date-time

Filter where updatedAt is greater than.

updatedAt[gte]

string · date-time

Filter where updatedAt is greater than or equal to.

updatedAt[lt]

string · date-time

Filter where updatedAt is less than.

updatedAt[lte]

string · date-time

Filter where updatedAt is less than or equal to.

List Tasks › Responses

Cursor-paginated collection envelope.

taskExpanded[] · required

The page of results.

total

integer

Total rows matching the query (across pages).

limit

integer

hasMore

boolean

nextCursor

string | null

Opaque cursor for the next page; null on the last page.

GET/tasks

curl "https://openapi.niftypm.com/api/v3/tasks" \
  -H "Authorization: Bearer $NIFTY_TOKEN"

Example Responses

{
  "data": [
    {
      "id": "KfS0ha8P",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1234,
      "name": "Example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 100,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    },
    {
      "id": "o9fSwokO",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1235,
      "name": "Second example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 101,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    }
  ],
  "total": 5,
  "limit": 2,
  "hasMore": true,
  "nextCursor": "b2NjdXJyZWRBdD0yMDI2LTA1LTMxVDEyOjAwOjAwWg"
}

json

application/json

Create Task

POST

https://openapi.niftypm.com/api/v3

/tasks

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Create a Task. Server-assigned fields are ignored if sent.

Required scope: tasks:write

Create Task › query Parameters

expand

string[] · style: form

Comma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.

Enum values:

project

status

list

parentTask

dependency

recurringRule

createdBy

archivedBy

Create Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Create Task › Request Body

taskCreate

name

string · minLength: 1 · maxLength: 1024 · required

Task name. 1–1024 characters after trimming. Content that reads as promotional (link-farm text, bulk marketing copy) is rejected with a 400.

Example: Example

projectId

string · minLength: 1 · required

Project this task belongs to. Required on create; PATCH-ing it moves the task — and its subtasks — into another project.

Example: iV6vIU8N

description

string | null

Task description. Supports Markdown formatting.

Example: A concise description.

archived

boolean

Whether this resource is archived.

Example: false

completed

boolean

Whether this task is marked complete. Set true to mark a task done — Nifty renders completed tasks in a virtual "Completed" column, so prefer this over creating a separate "Done" status. Pairs with completedAt (timestamp) and completedById (who completed it).

Example: false

listId

string | null

The list this task belongs to. Null when the task is not on a list. Legal ids come from GET /lists.

Example: lN6ZQycO

statusId

string | null

The status column this task sits in. Null when the task has no status (e.g. a backlog item). Legal ids come from GET /statuses.

Example: 5aM4ncwI

parentTaskId

string | null

The parent task, when this task is a subtask. Null on top-level tasks. Subtask siblings are ranked by order.

Example: 4KOocqYo

dependencyId

string | null

The single task this one waits on. Nifty models one predecessor per task, so this is an id and not an array. Null when the task has no predecessor.

Example: i9TUmOWm

recurringRuleId

string | null

The recurrence rule that regenerates this task, for recurring tasks. Null otherwise. Legal ids come from GET /recurring-rules.

Example: cn2v0xiQ

startAt

string | null · date-time

When work on this task is scheduled to start.

Example: 2026-06-01T12:00:00.000Z

dueAt

string | null · date-time

When this task is due.

Example: 2026-06-07T12:00:00.000Z

remindAt

string | null · date-time

A single reminder time for this task. Recurring or multiple reminders are separate objects on the reminder resource (GET /reminders?taskId[eq]=…).

Example: 2026-06-04T02:00:00.000Z

storyPoints

number | null

Story points used for agile estimation; client-supplied.

Example: 100

order

number | null

Fractional rank of the task in its default ordering. To reposition, send the midpoint of the two neighbours' ranks. Two subtasks under the same parent cannot share a rank.

Example: 100

orderList

number | null

Fractional rank of the task within its list. Same read/write shape and midpoint recipe as order.

Example: 100

banner

string | null

Cover image URL rendered at the top of the task detail view.

Example: https://cdn.nifty.pm/example.png

embedUrl

string | null

External URL embedded in the task body (e.g. Loom recording, Figma frame).

Example: https://example.com/resource

object[] · maxItems: 50

Custom-field values on this task. READ: ?expand=customFields returns the values attached to this task. WRITE: include customFields: [{ customFieldId, value }] in the create/update body to set values — each one is checked against its field definition before the write commits (value is always a string; max 50 entries per request; "" clears). Field definitions live on the read-only customField resource.

Example: []

assignees

string[] · maxItems: 50

Team-member ids assigned to this task. On create, seeds the set. On update, REPLACES the whole set — members you leave out are unassigned. For additive changes use POST/DELETE /tasks/{id}/assignees. Read the current set with ?expand=assignees.

Example: ["CNIgSuay"]

labels

string[] · maxItems: 50

Label ids attached to this task. On create, seeds the set. On update, REPLACES the whole set — labels you leave out are detached. For additive changes use POST/DELETE /tasks/{id}/labels. Read the current set with ?expand=labels.

Example: ["xbUMIqgS"]

subscribers

string[] · maxItems: 50

Team-member ids subscribed to this task (they receive notifications on changes). On create, seeds the set. On update, REPLACES the whole set — members you leave out are unsubscribed. For additive changes use POST/DELETE /tasks/{id}/subscribers. Read the current set with ?expand=subscribers.

Example: ["NlUEieKe"]

Create Task › Responses

Created

A Task with its `?expand=` relations inlined.

taskExpanded

id

string · minLength: 1 · readOnly · required

Unique identifier for this resource.

Example: KfS0ha8P

createdAt

string · date-time · readOnly · required

Creation timestamp.

Example: 2026-05-31T12:00:00.000Z

archived

boolean · required

Whether this resource is archived.

Example: false

name

string · minLength: 1 · required

Task name. 1–1024 characters after trimming. Content that reads as promotional (link-farm text, bulk marketing copy) is rejected with a 400.

Example: Example

completed

boolean · required

Example: false

projectId

string · minLength: 1 · required

Project this task belongs to. Required on create; PATCH-ing it moves the task — and its subtasks — into another project.

Example: iV6vIU8N

updatedAt

string | null · date-time · readOnly

Last update timestamp.

Example: 2026-05-31T14:00:00.000Z

createdByActorId

string | null · readOnly

Who created this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records created any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.

Example: 49f861f7-4af8-44bf-844f-45f85babe504

updatedByActorId

string | null · readOnly

Who last wrote to this record — a person, an agent, an automation or the system itself. Read-only, stamped by the server on writes made through this API, and null on records last written any other way, so treat it as present-or-null rather than always populated. This is an actor id (a UUID), not a member id: look it up with GET /actors/{id}, whose memberId gives you the person to use against /members.

Example: 3306ed14-3606-4350-8300-2f06e6c80dce

createdByActorType

string | null · enum · readOnly

The creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

updatedByActorType

string | null · enum · readOnly

The last writer actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type via the row's updatedByActorId; read-only, not directly writable.

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

archivedAt

string | null · date-time · readOnly

Timestamp when the task was archived. Server-stamped from the archived boolean — not directly writable.

Example: 2026-06-05T12:00:00.000Z

archivedById

string | null · readOnly

Member who archived this resource (server-stamped). A member id — resolve it with GET /members/{id}.

Example: 5S69rsOO

niceId

integer | null · readOnly

Per-project sequential counter assigned on insert. Compose with project.niceId for human-readable references (e.g. "PROJ-42"). Server-managed — read-only on the wire.

Example: 1234

description

string | null

Task description. Supports Markdown formatting.

Example: A concise description.

listId

string | null

The list this task belongs to. Null when the task is not on a list. Legal ids come from GET /lists.

Example: lN6ZQycO

statusId

string | null

The status column this task sits in. Null when the task has no status (e.g. a backlog item). Legal ids come from GET /statuses.

Example: 5aM4ncwI

parentTaskId

string | null

The parent task, when this task is a subtask. Null on top-level tasks. Subtask siblings are ranked by order.

Example: 4KOocqYo

dependencyId

string | null

The single task this one waits on. Nifty models one predecessor per task, so this is an id and not an array. Null when the task has no predecessor.

Example: i9TUmOWm

recurringRuleId

string | null

The recurrence rule that regenerates this task, for recurring tasks. Null otherwise. Legal ids come from GET /recurring-rules.

Example: cn2v0xiQ

startAt

string | null · date-time

When work on this task is scheduled to start.

Example: 2026-06-01T12:00:00.000Z

dueAt

string | null · date-time

When this task is due.

Example: 2026-06-07T12:00:00.000Z

completedAt

string | null · date-time · readOnly

Timestamp when the task was marked complete. Server-stamped from the completed boolean — not directly writable.

Example: 2026-06-03T12:00:00.000Z

remindAt

string | null · date-time

A single reminder time for this task. Recurring or multiple reminders are separate objects on the reminder resource (GET /reminders?taskId[eq]=…).

Example: 2026-06-04T02:00:00.000Z

storyPoints

number | null

Story points used for agile estimation; client-supplied.

Example: 100

order

number | null

Fractional rank of the task in its default ordering. To reposition, send the midpoint of the two neighbours' ranks. Two subtasks under the same parent cannot share a rank.

Example: 100

orderList

number | null

Fractional rank of the task within its list. Same read/write shape and midpoint recipe as order.

Example: 100

banner

string | null

Cover image URL rendered at the top of the task detail view.

Example: https://cdn.nifty.pm/example.png

embedUrl

string | null

External URL embedded in the task body (e.g. Loom recording, Figma frame).

Example: https://example.com/resource

createdById

string | null · readOnly

The team member who created this task. Server-set. Resolve it with ?expand=createdBy or GET /members/{id}; pairs with archivedById and completedById. This is a member id — createdByActorId is a different identifier space and GET /members/{id} will not accept it.

Example: njWQkGgk

completedById

string | null · readOnly

The team member who marked the task complete. Server-set when completed flips; pairs with completedAt. A member id — resolve it with GET /members/{id}.

Example: Kbmwwoue

object

The related Project, present only when you pass ?expand=project.

object

The related Status, present only when you pass ?expand=status.

object

The related List, present only when you pass ?expand=list.

object

The related Task, present only when you pass ?expand=parentTask.

object

The related Task, present only when you pass ?expand=dependency.

object

The related Recurring Rule, present only when you pass ?expand=recurringRule.

object

The related Team Member, present only when you pass ?expand=createdBy.

object

The related Team Member, present only when you pass ?expand=archivedBy.

object

The related Team Member, present only when you pass ?expand=completedBy.

object

The related Actor, present only when you pass ?expand=createdByActor.

object

The related Actor, present only when you pass ?expand=updatedByActor.

member[]

The linked Team Member rows, present only when you pass ?expand=assignees.

label[]

The linked Label rows, present only when you pass ?expand=labels.

member[]

The linked Team Member rows, present only when you pass ?expand=subscribers.

role[]

The linked Role rows, present only when you pass ?expand=hiddenFor.

task[]

The linked Task rows, present only when you pass ?expand=connectedTasks.

task[]

The linked Task rows, present only when you pass ?expand=subtasks.

message[]

The linked Message rows, present only when you pass ?expand=messages.

checklist[]

The linked Checklist rows, present only when you pass ?expand=checklists.

file[]

The linked File rows, present only when you pass ?expand=files.

object[]

The linked attachedCustomField rows, present only when you pass ?expand=customFields.

POST/tasks

curl -X POST "https://openapi.niftypm.com/api/v3/tasks" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","description":"A concise description.","archived":false,"completed":false,"projectId":"iV6vIU8N","listId":"lN6ZQycO","statusId":"5aM4ncwI","parentTaskId":"4KOocqYo","dependencyId":"i9TUmOWm","recurringRuleId":"cn2v0xiQ","startAt":"2026-06-01T12:00:00.000Z","dueAt":"2026-06-07T12:00:00.000Z","remindAt":"2026-06-04T02:00:00.000Z","storyPoints":100,"order":100,"orderList":100,"banner":"https://cdn.nifty.pm/example.png","embedUrl":"https://example.com/resource","customFields":[],"assignees":["CNIgSuay"],"labels":["xbUMIqgS"],"subscribers":["NlUEieKe"]}'

Example Request Body

{
  "name": "Example",
  "description": "A concise description.",
  "archived": false,
  "completed": false,
  "projectId": "iV6vIU8N",
  "listId": "lN6ZQycO",
  "statusId": "5aM4ncwI",
  "parentTaskId": "4KOocqYo",
  "dependencyId": "i9TUmOWm",
  "recurringRuleId": "cn2v0xiQ",
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "remindAt": "2026-06-04T02:00:00.000Z",
  "storyPoints": 100,
  "order": 100,
  "orderList": 100,
  "banner": "https://cdn.nifty.pm/example.png",
  "embedUrl": "https://example.com/resource",
  "customFields": [],
  "assignees": [
    "CNIgSuay"
  ],
  "labels": [
    "xbUMIqgS"
  ],
  "subscribers": [
    "NlUEieKe"
  ]
}

json

application/json

Example Responses

{
  "id": "KfS0ha8P",
  "createdAt": "2026-05-31T12:00:00.000Z",
  "updatedAt": "2026-05-31T14:00:00.000Z",
  "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
  "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
  "createdByActorType": "human",
  "updatedByActorType": "human",
  "archived": false,
  "niceId": 1234,
  "name": "Example",
  "description": "A concise description.",
  "completed": false,
  "projectId": "iV6vIU8N",
  "listId": "lN6ZQycO",
  "statusId": "5aM4ncwI",
  "parentTaskId": "4KOocqYo",
  "dependencyId": "i9TUmOWm",
  "recurringRuleId": "cn2v0xiQ",
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "remindAt": "2026-06-04T02:00:00.000Z",
  "storyPoints": 100,
  "order": 100,
  "orderList": 100,
  "banner": "https://cdn.nifty.pm/example.png",
  "embedUrl": "https://example.com/resource",
  "createdById": "njWQkGgk"
}

json

application/json

Get Task

GET

https://openapi.niftypm.com/api/v3

/tasks/{id}

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Retrieve a single Task by id.

Required scope: tasks:read

Get Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Get Task › query Parameters

expand

string[] · style: form

Comma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.

Enum values:

project

status

list

parentTask

dependency

recurringRule

createdBy

archivedBy

Get Task › Responses

A Task with its `?expand=` relations inlined.

taskExpanded

id

string · minLength: 1 · readOnly · required

Unique identifier for this resource.

Example: KfS0ha8P

createdAt

string · date-time · readOnly · required

Creation timestamp.

Example: 2026-05-31T12:00:00.000Z

archived

boolean · required

Whether this resource is archived.

Example: false

name

string · minLength: 1 · required

Task name. 1–1024 characters after trimming. Content that reads as promotional (link-farm text, bulk marketing copy) is rejected with a 400.

Example: Example

completed

boolean · required

Example: false

projectId

string · minLength: 1 · required

Project this task belongs to. Required on create; PATCH-ing it moves the task — and its subtasks — into another project.

Example: iV6vIU8N

updatedAt

string | null · date-time · readOnly

Last update timestamp.

Example: 2026-05-31T14:00:00.000Z

createdByActorId

string | null · readOnly

Example: 49f861f7-4af8-44bf-844f-45f85babe504

updatedByActorId

string | null · readOnly

Example: 3306ed14-3606-4350-8300-2f06e6c80dce

createdByActorType

string | null · enum · readOnly

The creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

updatedByActorType

string | null · enum · readOnly

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

archivedAt

string | null · date-time · readOnly

Timestamp when the task was archived. Server-stamped from the archived boolean — not directly writable.

Example: 2026-06-05T12:00:00.000Z

archivedById

string | null · readOnly

Member who archived this resource (server-stamped). A member id — resolve it with GET /members/{id}.

Example: 5S69rsOO

niceId

integer | null · readOnly

Per-project sequential counter assigned on insert. Compose with project.niceId for human-readable references (e.g. "PROJ-42"). Server-managed — read-only on the wire.

Example: 1234

description

string | null

Task description. Supports Markdown formatting.

Example: A concise description.

listId

string | null

The list this task belongs to. Null when the task is not on a list. Legal ids come from GET /lists.

Example: lN6ZQycO

statusId

string | null

The status column this task sits in. Null when the task has no status (e.g. a backlog item). Legal ids come from GET /statuses.

Example: 5aM4ncwI

parentTaskId

string | null

The parent task, when this task is a subtask. Null on top-level tasks. Subtask siblings are ranked by order.

Example: 4KOocqYo

dependencyId

string | null

The single task this one waits on. Nifty models one predecessor per task, so this is an id and not an array. Null when the task has no predecessor.

Example: i9TUmOWm

recurringRuleId

string | null

The recurrence rule that regenerates this task, for recurring tasks. Null otherwise. Legal ids come from GET /recurring-rules.

Example: cn2v0xiQ

startAt

string | null · date-time

When work on this task is scheduled to start.

Example: 2026-06-01T12:00:00.000Z

dueAt

string | null · date-time

When this task is due.

Example: 2026-06-07T12:00:00.000Z

completedAt

string | null · date-time · readOnly

Timestamp when the task was marked complete. Server-stamped from the completed boolean — not directly writable.

Example: 2026-06-03T12:00:00.000Z

remindAt

string | null · date-time

A single reminder time for this task. Recurring or multiple reminders are separate objects on the reminder resource (GET /reminders?taskId[eq]=…).

Example: 2026-06-04T02:00:00.000Z

storyPoints

number | null

Story points used for agile estimation; client-supplied.

Example: 100

order

number | null

Fractional rank of the task in its default ordering. To reposition, send the midpoint of the two neighbours' ranks. Two subtasks under the same parent cannot share a rank.

Example: 100

orderList

number | null

Fractional rank of the task within its list. Same read/write shape and midpoint recipe as order.

Example: 100

banner

string | null

Cover image URL rendered at the top of the task detail view.

Example: https://cdn.nifty.pm/example.png

embedUrl

string | null

External URL embedded in the task body (e.g. Loom recording, Figma frame).

Example: https://example.com/resource

createdById

string | null · readOnly

Example: njWQkGgk

completedById

string | null · readOnly

The team member who marked the task complete. Server-set when completed flips; pairs with completedAt. A member id — resolve it with GET /members/{id}.

Example: Kbmwwoue

object

The related Project, present only when you pass ?expand=project.

object

The related Status, present only when you pass ?expand=status.

object

The related List, present only when you pass ?expand=list.

object

The related Task, present only when you pass ?expand=parentTask.

object

The related Task, present only when you pass ?expand=dependency.

object

The related Recurring Rule, present only when you pass ?expand=recurringRule.

object

The related Team Member, present only when you pass ?expand=createdBy.

object

The related Team Member, present only when you pass ?expand=archivedBy.

object

The related Team Member, present only when you pass ?expand=completedBy.

object

The related Actor, present only when you pass ?expand=createdByActor.

object

The related Actor, present only when you pass ?expand=updatedByActor.

member[]

The linked Team Member rows, present only when you pass ?expand=assignees.

label[]

The linked Label rows, present only when you pass ?expand=labels.

member[]

The linked Team Member rows, present only when you pass ?expand=subscribers.

role[]

The linked Role rows, present only when you pass ?expand=hiddenFor.

task[]

The linked Task rows, present only when you pass ?expand=connectedTasks.

task[]

The linked Task rows, present only when you pass ?expand=subtasks.

message[]

The linked Message rows, present only when you pass ?expand=messages.

checklist[]

The linked Checklist rows, present only when you pass ?expand=checklists.

file[]

The linked File rows, present only when you pass ?expand=files.

object[]

The linked attachedCustomField rows, present only when you pass ?expand=customFields.

GET/tasks/{id}

curl "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P" \
  -H "Authorization: Bearer $NIFTY_TOKEN"

Example Responses

{
  "id": "KfS0ha8P",
  "createdAt": "2026-05-31T12:00:00.000Z",
  "updatedAt": "2026-05-31T14:00:00.000Z",
  "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
  "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
  "createdByActorType": "human",
  "updatedByActorType": "human",
  "archived": false,
  "niceId": 1234,
  "name": "Example",
  "description": "A concise description.",
  "completed": false,
  "projectId": "iV6vIU8N",
  "listId": "lN6ZQycO",
  "statusId": "5aM4ncwI",
  "parentTaskId": "4KOocqYo",
  "dependencyId": "i9TUmOWm",
  "recurringRuleId": "cn2v0xiQ",
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "remindAt": "2026-06-04T02:00:00.000Z",
  "storyPoints": 100,
  "order": 100,
  "orderList": 100,
  "banner": "https://cdn.nifty.pm/example.png",
  "embedUrl": "https://example.com/resource",
  "createdById": "njWQkGgk"
}

json

application/json

Delete Task

DELETE

https://openapi.niftypm.com/api/v3

/tasks/{id}

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Permanently delete this Task. This cannot be undone.

Required scope: tasks:delete

Delete Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Delete Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Delete Task › Responses

No Content

No data returned

Update Task

PATCH

https://openapi.niftypm.com/api/v3

/tasks/{id}

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Partially update a Task. Only the fields you send are changed.

Required scope: tasks:write

Update Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Update Task › query Parameters

expand

string[] · style: form

Comma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.

Enum values:

project

status

list

parentTask

dependency

recurringRule

createdBy

archivedBy

Update Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Update Task › Request Body

taskUpdate

name

string · minLength: 1 · maxLength: 1024

Task name. 1–1024 characters after trimming. Content that reads as promotional (link-farm text, bulk marketing copy) is rejected with a 400.

Example: Example

description

string | null

Task description. Supports Markdown formatting.

Example: A concise description.

archived

boolean

Whether this resource is archived.

Example: false

completed

boolean

Example: false

projectId

string · minLength: 1

Project this task belongs to. Required on create; PATCH-ing it moves the task — and its subtasks — into another project.

Example: iV6vIU8N

listId

string | null

The list this task belongs to. Null when the task is not on a list. Legal ids come from GET /lists.

Example: lN6ZQycO

statusId

string | null

The status column this task sits in. Null when the task has no status (e.g. a backlog item). Legal ids come from GET /statuses.

Example: 5aM4ncwI

parentTaskId

string | null

The parent task, when this task is a subtask. Null on top-level tasks. Subtask siblings are ranked by order.

Example: 4KOocqYo

dependencyId

string | null

The single task this one waits on. Nifty models one predecessor per task, so this is an id and not an array. Null when the task has no predecessor.

Example: i9TUmOWm

recurringRuleId

string | null

The recurrence rule that regenerates this task, for recurring tasks. Null otherwise. Legal ids come from GET /recurring-rules.

Example: cn2v0xiQ

startAt

string | null · date-time

When work on this task is scheduled to start.

Example: 2026-06-01T12:00:00.000Z

dueAt

string | null · date-time

When this task is due.

Example: 2026-06-07T12:00:00.000Z

remindAt

string | null · date-time

A single reminder time for this task. Recurring or multiple reminders are separate objects on the reminder resource (GET /reminders?taskId[eq]=…).

Example: 2026-06-04T02:00:00.000Z

storyPoints

number | null

Story points used for agile estimation; client-supplied.

Example: 100

order

number | null

Fractional rank of the task in its default ordering. To reposition, send the midpoint of the two neighbours' ranks. Two subtasks under the same parent cannot share a rank.

Example: 100

orderList

number | null

Fractional rank of the task within its list. Same read/write shape and midpoint recipe as order.

Example: 100

banner

string | null

Cover image URL rendered at the top of the task detail view.

Example: https://cdn.nifty.pm/example.png

embedUrl

string | null

External URL embedded in the task body (e.g. Loom recording, Figma frame).

Example: https://example.com/resource

object[] · maxItems: 50

Example: []

assignees

string[] · maxItems: 50

Example: ["CNIgSuay"]

labels

string[] · maxItems: 50

Example: ["xbUMIqgS"]

subscribers

string[] · maxItems: 50

Example: ["NlUEieKe"]

expectedUpdatedAt

string · date-time

Optional concurrency guard: the updatedAt you last read. If the resource has changed since, the update is rejected with 409 instead of overwriting the other writer. Re-read, re-derive your change from the current values, and retry with the fresh updatedAt.

Example: 2026-05-31T12:00:00.000Z

Update Task › Responses

A Task with its `?expand=` relations inlined.

taskExpanded

id

string · minLength: 1 · readOnly · required

Unique identifier for this resource.

Example: KfS0ha8P

createdAt

string · date-time · readOnly · required

Creation timestamp.

Example: 2026-05-31T12:00:00.000Z

archived

boolean · required

Whether this resource is archived.

Example: false

name

string · minLength: 1 · required

Task name. 1–1024 characters after trimming. Content that reads as promotional (link-farm text, bulk marketing copy) is rejected with a 400.

Example: Example

completed

boolean · required

Example: false

projectId

string · minLength: 1 · required

Project this task belongs to. Required on create; PATCH-ing it moves the task — and its subtasks — into another project.

Example: iV6vIU8N

updatedAt

string | null · date-time · readOnly

Last update timestamp.

Example: 2026-05-31T14:00:00.000Z

createdByActorId

string | null · readOnly

Example: 49f861f7-4af8-44bf-844f-45f85babe504

updatedByActorId

string | null · readOnly

Example: 3306ed14-3606-4350-8300-2f06e6c80dce

createdByActorType

string | null · enum · readOnly

The creator actor's type (human, agent, cron, recurringTask, automation, outboxRetry, systemDefault). Server-derived from actors.type; read-only, not directly writable.

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

updatedByActorType

string | null · enum · readOnly

Enum values:

human

agent

cron

recurringTask

automation

outboxRetry

systemDefault

Example: human

archivedAt

string | null · date-time · readOnly

Timestamp when the task was archived. Server-stamped from the archived boolean — not directly writable.

Example: 2026-06-05T12:00:00.000Z

archivedById

string | null · readOnly

Member who archived this resource (server-stamped). A member id — resolve it with GET /members/{id}.

Example: 5S69rsOO

niceId

integer | null · readOnly

Per-project sequential counter assigned on insert. Compose with project.niceId for human-readable references (e.g. "PROJ-42"). Server-managed — read-only on the wire.

Example: 1234

description

string | null

Task description. Supports Markdown formatting.

Example: A concise description.

listId

string | null

The list this task belongs to. Null when the task is not on a list. Legal ids come from GET /lists.

Example: lN6ZQycO

statusId

string | null

The status column this task sits in. Null when the task has no status (e.g. a backlog item). Legal ids come from GET /statuses.

Example: 5aM4ncwI

parentTaskId

string | null

The parent task, when this task is a subtask. Null on top-level tasks. Subtask siblings are ranked by order.

Example: 4KOocqYo

dependencyId

string | null

The single task this one waits on. Nifty models one predecessor per task, so this is an id and not an array. Null when the task has no predecessor.

Example: i9TUmOWm

recurringRuleId

string | null

The recurrence rule that regenerates this task, for recurring tasks. Null otherwise. Legal ids come from GET /recurring-rules.

Example: cn2v0xiQ

startAt

string | null · date-time

When work on this task is scheduled to start.

Example: 2026-06-01T12:00:00.000Z

dueAt

string | null · date-time

When this task is due.

Example: 2026-06-07T12:00:00.000Z

completedAt

string | null · date-time · readOnly

Timestamp when the task was marked complete. Server-stamped from the completed boolean — not directly writable.

Example: 2026-06-03T12:00:00.000Z

remindAt

string | null · date-time

A single reminder time for this task. Recurring or multiple reminders are separate objects on the reminder resource (GET /reminders?taskId[eq]=…).

Example: 2026-06-04T02:00:00.000Z

storyPoints

number | null

Story points used for agile estimation; client-supplied.

Example: 100

order

number | null

Fractional rank of the task in its default ordering. To reposition, send the midpoint of the two neighbours' ranks. Two subtasks under the same parent cannot share a rank.

Example: 100

orderList

number | null

Fractional rank of the task within its list. Same read/write shape and midpoint recipe as order.

Example: 100

banner

string | null

Cover image URL rendered at the top of the task detail view.

Example: https://cdn.nifty.pm/example.png

embedUrl

string | null

External URL embedded in the task body (e.g. Loom recording, Figma frame).

Example: https://example.com/resource

createdById

string | null · readOnly

Example: njWQkGgk

completedById

string | null · readOnly

The team member who marked the task complete. Server-set when completed flips; pairs with completedAt. A member id — resolve it with GET /members/{id}.

Example: Kbmwwoue

object

The related Project, present only when you pass ?expand=project.

object

The related Status, present only when you pass ?expand=status.

object

The related List, present only when you pass ?expand=list.

object

The related Task, present only when you pass ?expand=parentTask.

object

The related Task, present only when you pass ?expand=dependency.

object

The related Recurring Rule, present only when you pass ?expand=recurringRule.

object

The related Team Member, present only when you pass ?expand=createdBy.

object

The related Team Member, present only when you pass ?expand=archivedBy.

object

The related Team Member, present only when you pass ?expand=completedBy.

object

The related Actor, present only when you pass ?expand=createdByActor.

object

The related Actor, present only when you pass ?expand=updatedByActor.

member[]

The linked Team Member rows, present only when you pass ?expand=assignees.

label[]

The linked Label rows, present only when you pass ?expand=labels.

member[]

The linked Team Member rows, present only when you pass ?expand=subscribers.

role[]

The linked Role rows, present only when you pass ?expand=hiddenFor.

task[]

The linked Task rows, present only when you pass ?expand=connectedTasks.

task[]

The linked Task rows, present only when you pass ?expand=subtasks.

message[]

The linked Message rows, present only when you pass ?expand=messages.

checklist[]

The linked Checklist rows, present only when you pass ?expand=checklists.

file[]

The linked File rows, present only when you pass ?expand=files.

object[]

The linked attachedCustomField rows, present only when you pass ?expand=customFields.

PATCH/tasks/{id}

curl -X PATCH "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","description":"A concise description.","archived":false,"completed":false,"projectId":"iV6vIU8N","listId":"lN6ZQycO","statusId":"5aM4ncwI","parentTaskId":"4KOocqYo","dependencyId":"i9TUmOWm","recurringRuleId":"cn2v0xiQ","startAt":"2026-06-01T12:00:00.000Z","dueAt":"2026-06-07T12:00:00.000Z","remindAt":"2026-06-04T02:00:00.000Z","storyPoints":100,"order":100,"orderList":100,"banner":"https://cdn.nifty.pm/example.png","embedUrl":"https://example.com/resource","customFields":[],"assignees":["CNIgSuay"],"labels":["xbUMIqgS"],"subscribers":["NlUEieKe"],"expectedUpdatedAt":"2026-05-31T12:00:00.000Z"}'

Example Request Body

{
  "name": "Example",
  "description": "A concise description.",
  "archived": false,
  "completed": false,
  "projectId": "iV6vIU8N",
  "listId": "lN6ZQycO",
  "statusId": "5aM4ncwI",
  "parentTaskId": "4KOocqYo",
  "dependencyId": "i9TUmOWm",
  "recurringRuleId": "cn2v0xiQ",
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "remindAt": "2026-06-04T02:00:00.000Z",
  "storyPoints": 100,
  "order": 100,
  "orderList": 100,
  "banner": "https://cdn.nifty.pm/example.png",
  "embedUrl": "https://example.com/resource",
  "customFields": [],
  "assignees": [
    "CNIgSuay"
  ],
  "labels": [
    "xbUMIqgS"
  ],
  "subscribers": [
    "NlUEieKe"
  ],
  "expectedUpdatedAt": "2026-05-31T12:00:00.000Z"
}

json

application/json

Example Responses

{
  "id": "KfS0ha8P",
  "createdAt": "2026-05-31T12:00:00.000Z",
  "updatedAt": "2026-05-31T14:00:00.000Z",
  "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
  "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
  "createdByActorType": "human",
  "updatedByActorType": "human",
  "archived": false,
  "niceId": 1234,
  "name": "Example",
  "description": "A concise description.",
  "completed": false,
  "projectId": "iV6vIU8N",
  "listId": "lN6ZQycO",
  "statusId": "5aM4ncwI",
  "parentTaskId": "4KOocqYo",
  "dependencyId": "i9TUmOWm",
  "recurringRuleId": "cn2v0xiQ",
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "remindAt": "2026-06-04T02:00:00.000Z",
  "storyPoints": 100,
  "order": 100,
  "orderList": 100,
  "banner": "https://cdn.nifty.pm/example.png",
  "embedUrl": "https://example.com/resource",
  "createdById": "njWQkGgk"
}

json

application/json

Search Tasks

GET

https://openapi.niftypm.com/api/v3

/tasks/search

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Full-text ranked search across tasks. Ranked by relevance; pages are capped at 200 results. Filterable by 22 fields.

Required scope: tasks:read

Search Tasks › query Parameters

q

string · minLength: 3 · maxLength: 200 · required

Full-text search query. Trimmed before matching; URLs, e-mail addresses and HTML markup are rejected.

projectId

string · required

The project to search within. Required — tasks are project-scoped and search has no workspace-wide mode.

cursor

string

Opaque cursor for the next page (the envelope nextCursor).

limit

integer · min: 1 · max: 200

Items per page (1–200, default 50). A larger value is clamped to the cap rather than rejected, so always follow nextCursor instead of assuming one page held everything.

Default: 50

includeTotal

boolean

When true, the response envelope includes the total number of matching rows. Omit it for cheaper pagination.

expand

string[] · style: form

Comma-separated relations to inline (see Expanding objects above). Valid values are listed in the enum.

Enum values:

project

status

list

parentTask

dependency

recurringRule

createdBy

archivedBy

name[eq]

string

Filter where name equals.

name[contains]

string

Filter where name contains.

name[startsWith]

string

Filter where name starts with.

niceId[eq]

integer

Filter where niceId equals.

niceId[in]

integer[] · style: form

Filter where niceId is one of (comma-separated list).

archived[eq]

boolean

Filter where archived equals.

completed[eq]

boolean

Filter where completed equals.

projectId[eq]

string

Filter where projectId equals.

projectId[in]

string[] · style: form

Filter where projectId is one of (comma-separated list).

listId[eq]

string

Filter where listId equals.

listId[in]

string[] · style: form

Filter where listId is one of (comma-separated list).

statusId[eq]

string

Filter where statusId equals.

statusId[in]

string[] · style: form

Filter where statusId is one of (comma-separated list).

parentTaskId[eq]

string

Filter where parentTaskId equals.

parentTaskId[in]

string[] · style: form

Filter where parentTaskId is one of (comma-separated list).

dependencyId[eq]

string

Filter where dependencyId equals.

dependencyId[in]

string[] · style: form

Filter where dependencyId is one of (comma-separated list).

recurringRuleId[eq]

string

Filter where recurringRuleId equals.

recurringRuleId[in]

string[] · style: form

Filter where recurringRuleId is one of (comma-separated list).

createdById[eq]

string

Filter where createdById equals.

createdById[in]

string[] · style: form

Filter where createdById is one of (comma-separated list).

labelId[eq]

string

Filter where labelId equals.

labelId[in]

string[] · style: form

Filter where labelId is one of (comma-separated list).

assigneeId[eq]

string

Filter where assigneeId equals.

assigneeId[in]

string[] · style: form

Filter where assigneeId is one of (comma-separated list).

subscriberId[eq]

string

Filter where subscriberId equals.

subscriberId[in]

string[] · style: form

Filter where subscriberId is one of (comma-separated list).

createdByActorId[eq]

string

Filter where createdByActorId equals.

createdByActorId[in]

string[] · style: form

Filter where createdByActorId is one of (comma-separated list).

updatedByActorId[eq]

string

Filter where updatedByActorId equals.

updatedByActorId[in]

string[] · style: form

Filter where updatedByActorId is one of (comma-separated list).

startAt[gt]

string · date-time

Filter where startAt is greater than.

startAt[gte]

string · date-time

Filter where startAt is greater than or equal to.

startAt[lt]

string · date-time

Filter where startAt is less than.

startAt[lte]

string · date-time

Filter where startAt is less than or equal to.

dueAt[gt]

string · date-time

Filter where dueAt is greater than.

dueAt[gte]

string · date-time

Filter where dueAt is greater than or equal to.

dueAt[lt]

string · date-time

Filter where dueAt is less than.

dueAt[lte]

string · date-time

Filter where dueAt is less than or equal to.

completedAt[gt]

string · date-time

Filter where completedAt is greater than.

completedAt[gte]

string · date-time

Filter where completedAt is greater than or equal to.

completedAt[lt]

string · date-time

Filter where completedAt is less than.

completedAt[lte]

string · date-time

Filter where completedAt is less than or equal to.

archivedAt[gt]

string · date-time

Filter where archivedAt is greater than.

archivedAt[gte]

string · date-time

Filter where archivedAt is greater than or equal to.

archivedAt[lt]

string · date-time

Filter where archivedAt is less than.

archivedAt[lte]

string · date-time

Filter where archivedAt is less than or equal to.

createdAt[gt]

string · date-time

Filter where createdAt is greater than.

createdAt[gte]

string · date-time

Filter where createdAt is greater than or equal to.

createdAt[lt]

string · date-time

Filter where createdAt is less than.

createdAt[lte]

string · date-time

Filter where createdAt is less than or equal to.

updatedAt[gt]

string · date-time

Filter where updatedAt is greater than.

updatedAt[gte]

string · date-time

Filter where updatedAt is greater than or equal to.

updatedAt[lt]

string · date-time

Filter where updatedAt is less than.

updatedAt[lte]

string · date-time

Filter where updatedAt is less than or equal to.

Search Tasks › Responses

Cursor-paginated collection envelope.

taskExpanded[] · required

The page of results.

total

integer

Total rows matching the query (across pages).

limit

integer

hasMore

boolean

nextCursor

string | null

Opaque cursor for the next page; null on the last page.

GET/tasks/search

curl "https://openapi.niftypm.com/api/v3/tasks/search?q=design&projectId=iV6vIU8N" \
  -H "Authorization: Bearer $NIFTY_TOKEN"

Example Responses

{
  "data": [
    {
      "id": "KfS0ha8P",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1234,
      "name": "Example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 100,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    },
    {
      "id": "o9fSwokO",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1235,
      "name": "Second example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 101,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    }
  ],
  "total": 5,
  "limit": 2,
  "hasMore": true,
  "nextCursor": "b2NjdXJyZWRBdD0yMDI2LTA1LTMxVDEyOjAwOjAwWg"
}

json

application/json

Add assignees to a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/assignees

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Link the given ids to this Task as assignees. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete assignees set afterwards.

Required scopes: tasks:write tasks:link

Add assignees to a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Add assignees to a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Add assignees to a Task › Request Body

ids

string[] · required

Team Members to add or remove, by id.

Add assignees to a Task › Responses

member[] · required

The complete assignees set after the change.

affectedIds

string[] · required

The ids that were actually linked (ones already linked are omitted).

missingIds

string[]

Ids you sent that do not exist or are not visible to this token.

POST/tasks/{id}/assignees

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/assignees" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["P3hYIKqK","nvgG0jMq"]}'

Example Request Body

{
  "ids": [
    "P3hYIKqK",
    "nvgG0jMq"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "P3hYIKqK",
      "userId": "EF6LMc0F",
      "name": "Example",
      "email": "jane@acme.com",
      "avatar": "https://cdn.nifty.pm/example.png",
      "initials": "NB",
      "color": "#00A99B",
      "online": false,
      "tzIana": "America/New_York",
      "pending": false,
      "removed": false,
      "roleId": "zngY4nUy",
      "theme": "light",
      "storyPointsCapacity": 100
    }
  ],
  "affectedIds": [
    "P3hYIKqK"
  ],
  "missingIds": []
}

json

application/json

Remove assignees from a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/assignees/remove

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Unlink the given ids from this Task's assignees. Removing one that is not linked changes nothing. Returns the complete assignees set afterwards.

Required scopes: tasks:write tasks:link

Remove assignees from a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Remove assignees from a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Remove assignees from a Task › Request Body

ids

string[] · required

Team Members to add or remove, by id.

Remove assignees from a Task › Responses

member[] · required

The complete assignees set after the change.

affectedIds

string[] · required

The ids that were actually unlinked (ones not linked are omitted).

POST/tasks/{id}/assignees/remove

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/assignees/remove" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["P3hYIKqK","nvgG0jMq"]}'

Example Request Body

{
  "ids": [
    "P3hYIKqK",
    "nvgG0jMq"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "P3hYIKqK",
      "userId": "EF6LMc0F",
      "name": "Example",
      "email": "jane@acme.com",
      "avatar": "https://cdn.nifty.pm/example.png",
      "initials": "NB",
      "color": "#00A99B",
      "online": false,
      "tzIana": "America/New_York",
      "pending": false,
      "removed": false,
      "roleId": "zngY4nUy",
      "theme": "light",
      "storyPointsCapacity": 100
    }
  ],
  "affectedIds": [
    "P3hYIKqK"
  ]
}

json

application/json

Add labels to a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/labels

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Link the given ids to this Task as labels. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete labels set afterwards.

Required scopes: tasks:write tasks:link

Add labels to a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Add labels to a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Add labels to a Task › Request Body

ids

string[] · required

Labels to add or remove, by id.

Add labels to a Task › Responses

label[] · required

The complete labels set after the change.

affectedIds

string[] · required

The ids that were actually linked (ones already linked are omitted).

missingIds

string[]

Ids you sent that do not exist or are not visible to this token.

POST/tasks/{id}/labels

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/labels" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["xbUMIqgS","rXYsOME8"]}'

Example Request Body

{
  "ids": [
    "xbUMIqgS",
    "rXYsOME8"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "xbUMIqgS",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "purgeAt": "2026-06-30T12:00:00.000Z",
      "deletedById": "7ESqMCCu",
      "name": "Example",
      "color": "#00A99B",
      "default": false,
      "type": "others"
    }
  ],
  "affectedIds": [
    "xbUMIqgS"
  ],
  "missingIds": []
}

json

application/json

Remove labels from a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/labels/remove

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Unlink the given ids from this Task's labels. Removing one that is not linked changes nothing. Returns the complete labels set afterwards.

Required scopes: tasks:write tasks:link

Remove labels from a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Remove labels from a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Remove labels from a Task › Request Body

ids

string[] · required

Labels to add or remove, by id.

Remove labels from a Task › Responses

label[] · required

The complete labels set after the change.

affectedIds

string[] · required

The ids that were actually unlinked (ones not linked are omitted).

POST/tasks/{id}/labels/remove

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/labels/remove" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["xbUMIqgS","rXYsOME8"]}'

Example Request Body

{
  "ids": [
    "xbUMIqgS",
    "rXYsOME8"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "xbUMIqgS",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "purgeAt": "2026-06-30T12:00:00.000Z",
      "deletedById": "7ESqMCCu",
      "name": "Example",
      "color": "#00A99B",
      "default": false,
      "type": "others"
    }
  ],
  "affectedIds": [
    "xbUMIqgS"
  ]
}

json

application/json

Add subscribers to a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/subscribers

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Link the given ids to this Task as subscribers. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete subscribers set afterwards.

Required scopes: tasks:write tasks:link

Add subscribers to a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Add subscribers to a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Add subscribers to a Task › Request Body

ids

string[] · required

Team Members to add or remove, by id.

Add subscribers to a Task › Responses

member[] · required

The complete subscribers set after the change.

affectedIds

string[] · required

The ids that were actually linked (ones already linked are omitted).

missingIds

string[]

Ids you sent that do not exist or are not visible to this token.

POST/tasks/{id}/subscribers

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/subscribers" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["P3hYIKqK","nvgG0jMq"]}'

Example Request Body

{
  "ids": [
    "P3hYIKqK",
    "nvgG0jMq"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "P3hYIKqK",
      "userId": "EF6LMc0F",
      "name": "Example",
      "email": "jane@acme.com",
      "avatar": "https://cdn.nifty.pm/example.png",
      "initials": "NB",
      "color": "#00A99B",
      "online": false,
      "tzIana": "America/New_York",
      "pending": false,
      "removed": false,
      "roleId": "zngY4nUy",
      "theme": "light",
      "storyPointsCapacity": 100
    }
  ],
  "affectedIds": [
    "P3hYIKqK"
  ],
  "missingIds": []
}

json

application/json

Remove subscribers from a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/subscribers/remove

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Unlink the given ids from this Task's subscribers. Removing one that is not linked changes nothing. Returns the complete subscribers set afterwards.

Required scopes: tasks:write tasks:link

Remove subscribers from a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Remove subscribers from a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Remove subscribers from a Task › Request Body

ids

string[] · required

Team Members to add or remove, by id.

Remove subscribers from a Task › Responses

member[] · required

The complete subscribers set after the change.

affectedIds

string[] · required

The ids that were actually unlinked (ones not linked are omitted).

POST/tasks/{id}/subscribers/remove

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/subscribers/remove" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["P3hYIKqK","nvgG0jMq"]}'

Example Request Body

{
  "ids": [
    "P3hYIKqK",
    "nvgG0jMq"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "P3hYIKqK",
      "userId": "EF6LMc0F",
      "name": "Example",
      "email": "jane@acme.com",
      "avatar": "https://cdn.nifty.pm/example.png",
      "initials": "NB",
      "color": "#00A99B",
      "online": false,
      "tzIana": "America/New_York",
      "pending": false,
      "removed": false,
      "roleId": "zngY4nUy",
      "theme": "light",
      "storyPointsCapacity": 100
    }
  ],
  "affectedIds": [
    "P3hYIKqK"
  ]
}

json

application/json

Add hidden for to a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/hidden-for

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Link the given ids to this Task as hiddenFor. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete hiddenFor set afterwards.

Required scopes: tasks:write tasks:link

Add hidden for to a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Add hidden for to a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Add hidden for to a Task › Request Body

ids

string[] · required

Roles to add or remove, by id.

Add hidden for to a Task › Responses

role[] · required

The complete hiddenFor set after the change.

affectedIds

string[] · required

The ids that were actually linked (ones already linked are omitted).

missingIds

string[]

Ids you sent that do not exist or are not visible to this token.

POST/tasks/{id}/hidden-for

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/hidden-for" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["zngY4nUy","50hcKom2"]}'

Example Request Body

{
  "ids": [
    "zngY4nUy",
    "50hcKom2"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "zngY4nUy",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "name": "Example",
      "editable": false,
      "permissions": [
        "createTask",
        "editTask",
        "viewAllTasks"
      ],
      "initialScreen": "allTasks"
    }
  ],
  "affectedIds": [
    "zngY4nUy"
  ],
  "missingIds": []
}

json

application/json

Remove hidden for from a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/hidden-for/remove

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Unlink the given ids from this Task's hiddenFor. Removing one that is not linked changes nothing. Returns the complete hiddenFor set afterwards.

Required scopes: tasks:write tasks:link

Remove hidden for from a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Remove hidden for from a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Remove hidden for from a Task › Request Body

ids

string[] · required

Roles to add or remove, by id.

Remove hidden for from a Task › Responses

role[] · required

The complete hiddenFor set after the change.

affectedIds

string[] · required

The ids that were actually unlinked (ones not linked are omitted).

POST/tasks/{id}/hidden-for/remove

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/hidden-for/remove" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["zngY4nUy","50hcKom2"]}'

Example Request Body

{
  "ids": [
    "zngY4nUy",
    "50hcKom2"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "zngY4nUy",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "name": "Example",
      "editable": false,
      "permissions": [
        "createTask",
        "editTask",
        "viewAllTasks"
      ],
      "initialScreen": "allTasks"
    }
  ],
  "affectedIds": [
    "zngY4nUy"
  ]
}

json

application/json

Add connected tasks to a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/connected-tasks

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Link the given ids to this Task as connectedTasks. Adds to the existing set rather than replacing it, and adding one that is already linked changes nothing. Returns the complete connectedTasks set afterwards.

Required scopes: tasks:write tasks:link

Add connected tasks to a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Add connected tasks to a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Add connected tasks to a Task › Request Body

ids

string[] · required

Tasks to add or remove, by id.

Add connected tasks to a Task › Responses

task[] · required

The complete connectedTasks set after the change.

affectedIds

string[] · required

The ids that were actually linked (ones already linked are omitted).

missingIds

string[]

Ids you sent that do not exist or are not visible to this token.

POST/tasks/{id}/connected-tasks

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/connected-tasks" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["KfS0ha8P","AfOKgoI8"]}'

Example Request Body

{
  "ids": [
    "KfS0ha8P",
    "AfOKgoI8"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "KfS0ha8P",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1234,
      "name": "Example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 100,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    }
  ],
  "affectedIds": [
    "KfS0ha8P"
  ],
  "missingIds": []
}

json

application/json

Remove connected tasks from a Task

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/connected-tasks/remove

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Unlink the given ids from this Task's connectedTasks. Removing one that is not linked changes nothing. Returns the complete connectedTasks set afterwards.

Required scopes: tasks:write tasks:link

Remove connected tasks from a Task › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Remove connected tasks from a Task › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Remove connected tasks from a Task › Request Body

ids

string[] · required

Tasks to add or remove, by id.

Remove connected tasks from a Task › Responses

task[] · required

The complete connectedTasks set after the change.

affectedIds

string[] · required

The ids that were actually unlinked (ones not linked are omitted).

POST/tasks/{id}/connected-tasks/remove

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/KfS0ha8P/connected-tasks/remove" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"ids":["KfS0ha8P","AfOKgoI8"]}'

Example Request Body

{
  "ids": [
    "KfS0ha8P",
    "AfOKgoI8"
  ]
}

json

application/json

Example Responses

{
  "data": [
    {
      "id": "KfS0ha8P",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "updatedAt": "2026-05-31T14:00:00.000Z",
      "createdByActorId": "49f861f7-4af8-44bf-844f-45f85babe504",
      "updatedByActorId": "3306ed14-3606-4350-8300-2f06e6c80dce",
      "createdByActorType": "human",
      "updatedByActorType": "human",
      "archived": false,
      "niceId": 1234,
      "name": "Example",
      "description": "A concise description.",
      "completed": false,
      "projectId": "iV6vIU8N",
      "listId": "lN6ZQycO",
      "statusId": "5aM4ncwI",
      "parentTaskId": "4KOocqYo",
      "dependencyId": "i9TUmOWm",
      "recurringRuleId": "cn2v0xiQ",
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "remindAt": "2026-06-04T02:00:00.000Z",
      "storyPoints": 100,
      "order": 100,
      "orderList": 100,
      "banner": "https://cdn.nifty.pm/example.png",
      "embedUrl": "https://example.com/resource",
      "createdById": "njWQkGgk"
    }
  ],
  "affectedIds": [
    "KfS0ha8P"
  ]
}

json

application/json

Create tree (Task)

POST

https://openapi.niftypm.com/api/v3

/tasks/create-tree

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Create a task with its subtasks and their checklists in one atomic call — no id-threading, no half-built trees.

Required scope: tasks:write

Create tree (Task) › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Create tree (Task) › Request Body

name

string · minLength: 1 · required

projectId

string · minLength: 1 · required

description

string

assignees

string[]

labels

string[]

startAt

string · date-time

dueAt

string · date-time

completed

boolean

statusId

string · minLength: 1

object[] · maxItems: 50

object[] · maxItems: 100

Create tree (Task) › Responses

id

string · required

niceId

number · required

object[] · required

POST/tasks/create-tree

curl -X POST "https://openapi.niftypm.com/api/v3/tasks/create-tree" \
  -H "Authorization: Bearer $NIFTY_TOKEN" \
  -H "Idempotency-Key: 3f0b1c8a-9f0e-4a2f-8f5e-2b7c9d1e4a60" \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","description":"A concise description.","assignees":["Example assignees"],"labels":["Example labels"],"startAt":"2026-06-01T12:00:00.000Z","dueAt":"2026-06-07T12:00:00.000Z","completed":false,"statusId":"5aM4ncwI","customFields":[{"customFieldId":"6GWCcskG","value":"Example value"}],"projectId":"iV6vIU8N","subtasks":[{"name":"Example","description":"A concise description.","assignees":["Example assignees"],"labels":["Example labels"],"startAt":"2026-06-01T12:00:00.000Z","dueAt":"2026-06-07T12:00:00.000Z","completed":false,"statusId":"5aM4ncwI","customFields":[{"customFieldId":"6GWCcskG","value":"Example value"}],"checklists":[{"name":"Example","items":["Example items"]}]}]}'

Example Request Body

{
  "name": "Example",
  "description": "A concise description.",
  "assignees": [
    "Example assignees"
  ],
  "labels": [
    "Example labels"
  ],
  "startAt": "2026-06-01T12:00:00.000Z",
  "dueAt": "2026-06-07T12:00:00.000Z",
  "completed": false,
  "statusId": "5aM4ncwI",
  "customFields": [
    {
      "customFieldId": "6GWCcskG",
      "value": "Example value"
    }
  ],
  "projectId": "iV6vIU8N",
  "subtasks": [
    {
      "name": "Example",
      "description": "A concise description.",
      "assignees": [
        "Example assignees"
      ],
      "labels": [
        "Example labels"
      ],
      "startAt": "2026-06-01T12:00:00.000Z",
      "dueAt": "2026-06-07T12:00:00.000Z",
      "completed": false,
      "statusId": "5aM4ncwI",
      "customFields": [
        {
          "customFieldId": "6GWCcskG",
          "value": "Example value"
        }
      ],
      "checklists": [
        {
          "name": "Example",
          "items": [
            "Example items"
          ]
        }
      ]
    }
  ]
}

json

application/json

Example Responses

{
  "id": "XXKmAKg6",
  "niceId": 1234,
  "subtasks": [
    {
      "id": "XXKmAKg6",
      "checklists": [
        {
          "id": "XXKmAKg6",
          "itemIds": [
            "Example item ids"
          ]
        }
      ]
    }
  ]
}

json

application/json

Attach document (Task)

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/attach-document

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Attach an existing document to this task (id = the task, documentId = the document; both must already exist in the same workspace). Idempotent — re-attaching is a no-op. Task assignees gain access to the document.

Required scope: tasks:write

Attach document (Task) › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Attach document (Task) › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Attach document (Task) › Request Body

documentId

string · minLength: 1 · required

Attach document (Task) › Responses

taskId

string · minLength: 1 · required

documentId

string · minLength: 1 · required

Detach document (Task)

POST

https://openapi.niftypm.com/api/v3

/tasks/{id}/detach-document

Bearer (nft_user_* (personal access token) or nft_oauth_* (OAuth 2.1 access token))

OAuth 2.0

Detach a previously attached document from this task (id = the task, documentId = the document). Idempotent.

Required scope: tasks:write

Detach document (Task) › path Parameters

id

string · minLength: 1 · pattern: ^[0-9A-Za-z_!]+$ · required

Id of the Task.

Detach document (Task) › Headers

Idempotency-Key

string · maxLength: 250

Optional replay key (see Idempotent requests above).

Detach document (Task) › Request Body

documentId

string · minLength: 1 · required

Detach document (Task) › Responses

taskId

string · minLength: 1 · required

documentId

string · minLength: 1 · required

Handoff

Was this page helpful?