Project activity

Download schema

The per-project activity feed: one append-only row per domain event. Rows are server-emitted — they cannot be created, edited or deleted. Pass ?projectId[eq]=<id> to fetch a single project’s feed. Exactly one of taskId, listId, documentId and fileId is set on any given row, determined by type; project-level events set none of them. The mapping is: taskCompleted → taskId; listCreated, listMilestoneCreated and listUnlocked → listId; docCreated → documentId; fileUploaded → fileId; usersJoined and usersLeft → memberId; projectCreated → none. Newest first by default.

List Project activities

GET

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

/project-activities

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

OAuth 2.0

List projectActivities. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 8 fields. Ordered by -createdAt unless you pass sort.

Required scope: project-activities:read

List Project activities › query Parameters

projectId

string

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

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: -createdAt. Listing without projectId orders by -updatedAt instead.

Enum values:

createdAt

-createdAt

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

task

list

document

file

triggeredBy

type[eq]

string · enum

Filter where type equals.

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

type[in]

string[] · style: form

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

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

projectId[eq]

string

Filter where projectId equals.

projectId[in]

string[] · style: form

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

taskId[eq]

string

Filter where taskId equals.

taskId[in]

string[] · style: form

Filter where taskId 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).

documentId[eq]

string

Filter where documentId equals.

documentId[in]

string[] · style: form

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

fileId[eq]

string

Filter where fileId equals.

fileId[in]

string[] · style: form

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

triggeredById[eq]

string

Filter where triggeredById equals.

triggeredById[in]

string[] · style: form

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

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.

List Project activities › Responses

Cursor-paginated collection envelope.

projectActivityExpanded[] · 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/project-activities

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

Example Responses

{
  "data": [
    {
      "id": "Nl0Hmwsa",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "projectId": "iV6vIU8N",
      "type": "taskCompleted",
      "taskId": "KfS0ha8P",
      "listId": "lN6ZQycO",
      "documentId": "ELe0nkum",
      "fileId": "xvM2toUM",
      "memberId": "P3hYIKqK",
      "triggeredById": "lvc47DE8"
    },
    {
      "id": "FnUQsma0",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "projectId": "iV6vIU8N",
      "type": "taskCompleted",
      "taskId": "KfS0ha8P",
      "listId": "lN6ZQycO",
      "documentId": "ELe0nkum",
      "fileId": "xvM2toUM",
      "memberId": "P3hYIKqK",
      "triggeredById": "lvc47DE8"
    }
  ],
  "total": 5,
  "limit": 2,
  "hasMore": true,
  "nextCursor": "b2NjdXJyZWRBdD0yMDI2LTA1LTMxVDEyOjAwOjAwWg"
}

json

application/json

Get Project activity

GET

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

/project-activities/{id}

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

OAuth 2.0

Retrieve a single Project activity by id.

Required scope: project-activities:read

Get Project activity › path Parameters

id

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

Id of the Project activity.

Get Project activity › 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

task

list

document

file

triggeredBy

Get Project activity › Responses

A Project activity with its `?expand=` relations inlined.

projectActivityExpanded

id

string · minLength: 1 · readOnly · required

Unique identifier for this resource.

Example: Nl0Hmwsa

createdAt

string · date-time · readOnly · required

When the event happened.

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

projectId

string · minLength: 1 · readOnly · required

The project this activity belongs to.

Example: iV6vIU8N

type

string · enum · readOnly · required

What happened: projectCreated, usersJoined, usersLeft, listCreated, listMilestoneCreated, listUnlocked, taskCompleted, fileUploaded or docCreated. This value determines which of the reference ids below is set.

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

Example: taskCompleted

taskId

string | null · readOnly

The task this activity references. Set for taskCompleted; null otherwise.

Example: KfS0ha8P

listId

string | null · readOnly

The list this activity references. Set for listCreated, listMilestoneCreated and listUnlocked; null otherwise.

Example: lN6ZQycO

documentId

string | null · readOnly

The document this activity references. Set for docCreated; null otherwise.

Example: ELe0nkum

fileId

string | null · readOnly

The file this activity references. Set for fileUploaded; null otherwise.

Example: xvM2toUM

memberId

string | null · readOnly

The team member who joined or left. Set for usersJoined and usersLeft; null otherwise.

Example: P3hYIKqK

triggeredById

string | null · readOnly

The team member who triggered this event, or null when it was triggered by an automation, an agent or a scheduled job. A member id — resolve it with GET /members/{id}.

Example: lvc47DE8

object

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

object

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

object

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

object

The related Document, present only when you pass ?expand=document.

object

The related File, present only when you pass ?expand=file.

object

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

Project Dashboard Custom Field

Was this page helpful?

Nifty v3 API (Public)

Project activity

Download schema

List Project activities

GET

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

/project-activities

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

OAuth 2.0

List projectActivities. Returns a paginated envelope (data, total, limit, hasMore, nextCursor). Filterable by 8 fields. Ordered by -createdAt unless you pass sort.

Required scope: project-activities:read

List Project activities › query Parameters

projectId

string

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

sort

string · enum

Enum values:

createdAt

-createdAt

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

task

list

document

file

triggeredBy

type[eq]

string · enum

Filter where type equals.

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

type[in]

string[] · style: form

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

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

projectId[eq]

string

Filter where projectId equals.

projectId[in]

string[] · style: form

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

taskId[eq]

string

Filter where taskId equals.

taskId[in]

string[] · style: form

Filter where taskId 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).

documentId[eq]

string

Filter where documentId equals.

documentId[in]

string[] · style: form

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

fileId[eq]

string

Filter where fileId equals.

fileId[in]

string[] · style: form

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

triggeredById[eq]

string

Filter where triggeredById equals.

triggeredById[in]

string[] · style: form

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

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.

List Project activities › Responses

Cursor-paginated collection envelope.

projectActivityExpanded[] · 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/project-activities

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

Example Responses

{
  "data": [
    {
      "id": "Nl0Hmwsa",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "projectId": "iV6vIU8N",
      "type": "taskCompleted",
      "taskId": "KfS0ha8P",
      "listId": "lN6ZQycO",
      "documentId": "ELe0nkum",
      "fileId": "xvM2toUM",
      "memberId": "P3hYIKqK",
      "triggeredById": "lvc47DE8"
    },
    {
      "id": "FnUQsma0",
      "createdAt": "2026-05-31T12:00:00.000Z",
      "projectId": "iV6vIU8N",
      "type": "taskCompleted",
      "taskId": "KfS0ha8P",
      "listId": "lN6ZQycO",
      "documentId": "ELe0nkum",
      "fileId": "xvM2toUM",
      "memberId": "P3hYIKqK",
      "triggeredById": "lvc47DE8"
    }
  ],
  "total": 5,
  "limit": 2,
  "hasMore": true,
  "nextCursor": "b2NjdXJyZWRBdD0yMDI2LTA1LTMxVDEyOjAwOjAwWg"
}

json

application/json

Get Project activity

GET

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

/project-activities/{id}

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

OAuth 2.0

Retrieve a single Project activity by id.

Required scope: project-activities:read

Get Project activity › path Parameters

id

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

Id of the Project activity.

Get Project activity › 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

task

list

document

file

triggeredBy

Get Project activity › Responses

A Project activity with its `?expand=` relations inlined.

projectActivityExpanded

id

string · minLength: 1 · readOnly · required

Unique identifier for this resource.

Example: Nl0Hmwsa

createdAt

string · date-time · readOnly · required

When the event happened.

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

projectId

string · minLength: 1 · readOnly · required

The project this activity belongs to.

Example: iV6vIU8N

type

string · enum · readOnly · required

Enum values:

projectCreated

usersJoined

usersLeft

listCreated

listMilestoneCreated

listUnlocked

taskCompleted

fileUploaded

Example: taskCompleted

taskId

string | null · readOnly

The task this activity references. Set for taskCompleted; null otherwise.

Example: KfS0ha8P

listId

string | null · readOnly

The list this activity references. Set for listCreated, listMilestoneCreated and listUnlocked; null otherwise.

Example: lN6ZQycO

documentId

string | null · readOnly

The document this activity references. Set for docCreated; null otherwise.

Example: ELe0nkum

fileId

string | null · readOnly

The file this activity references. Set for fileUploaded; null otherwise.

Example: xvM2toUM

memberId

string | null · readOnly

The team member who joined or left. Set for usersJoined and usersLeft; null otherwise.

Example: P3hYIKqK

triggeredById

string | null · readOnly

The team member who triggered this event, or null when it was triggered by an automation, an agent or a scheduled job. A member id — resolve it with GET /members/{id}.

Example: lvc47DE8

object

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

object

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

object

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

object

The related Document, present only when you pass ?expand=document.

object

The related File, present only when you pass ?expand=file.

object

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

Project Dashboard Custom Field

Was this page helpful?