For the complete documentation index, see llms.txt. This page is also available as Markdown.

Activities

Activity management operations

List all activities

get

Returns all activities accessible to the authenticated user within their organization

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Responses
200

List of activities

application/json
idintegerRequired

Unique activity identifier

Example: 1
timestampstring · date-timeRequired

When the activity occurred

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequired

Activity type

Example: meetingPossible values:
subtypestring · nullableOptional

Activity subtype for categorization

Example: kickoff
descriptionstringRequired

Activity description/content

Example: Discussed project timeline and deliverables
projectIdinteger · nullableOptional

Associated project ID

organizationIdinteger · nullableOptional

Associated organization ID

creatorIdintegerRequired

User ID who created the activity

Example: 5
metadataobject · nullableOptional

Additional activity metadata

evidenceobject · nullableOptional

Supporting evidence/attachments

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

get/activities
GET /api/activities HTTP/1.1
Accept: */*
[
  {
    "id": 1,
    "timestamp": "2026-01-20T14:30:00.000Z",
    "type": "meeting",
    "subtype": "kickoff",
    "description": "Discussed project timeline and deliverables",
    "projectId": 1,
    "organizationId": 1,
    "creatorId": 5,
    "metadata": {},
    "evidence": {},
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "creator": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    },
    "project": {
      "id": 1,
      "title": "text"
    }
  }
]

Create a new activity

post

Creates a new activity (note, email, phone call, meeting, etc.)

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Body
timestampstring · date-timeRequired

When the activity occurred (ISO 8601 format)

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequiredExample: notePossible values:
subtypestring · nullableOptional
descriptionstringRequired

Activity description/content

Example: Follow-up call with client
projectIdinteger · nullableOptional

Project to associate with

organizationIdinteger · nullableOptional

Organization to associate with

metadataobject · nullableOptional
evidenceobject · nullableOptional
Responses
200

Activity created successfully

application/json
idintegerRequired

Unique activity identifier

Example: 1
timestampstring · date-timeRequired

When the activity occurred

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequired

Activity type

Example: meetingPossible values:
subtypestring · nullableOptional

Activity subtype for categorization

Example: kickoff
descriptionstringRequired

Activity description/content

Example: Discussed project timeline and deliverables
projectIdinteger · nullableOptional

Associated project ID

organizationIdinteger · nullableOptional

Associated organization ID

creatorIdintegerRequired

User ID who created the activity

Example: 5
metadataobject · nullableOptional

Additional activity metadata

evidenceobject · nullableOptional

Supporting evidence/attachments

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

post/activities
POST /api/activities HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "timestamp": "2026-01-20T14:30:00.000Z",
  "type": "note",
  "subtype": "text",
  "description": "Follow-up call with client",
  "projectId": 1,
  "organizationId": 1,
  "metadata": {},
  "evidence": {}
}
{
  "id": 1,
  "timestamp": "2026-01-20T14:30:00.000Z",
  "type": "meeting",
  "subtype": "kickoff",
  "description": "Discussed project timeline and deliverables",
  "projectId": 1,
  "organizationId": 1,
  "creatorId": 5,
  "metadata": {},
  "evidence": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Get an activity

get

Returns a specific activity by ID

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
idintegerRequired

Activity ID

Responses
200

Activity details

application/json
idintegerRequired

Unique activity identifier

Example: 1
timestampstring · date-timeRequired

When the activity occurred

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequired

Activity type

Example: meetingPossible values:
subtypestring · nullableOptional

Activity subtype for categorization

Example: kickoff
descriptionstringRequired

Activity description/content

Example: Discussed project timeline and deliverables
projectIdinteger · nullableOptional

Associated project ID

organizationIdinteger · nullableOptional

Associated organization ID

creatorIdintegerRequired

User ID who created the activity

Example: 5
metadataobject · nullableOptional

Additional activity metadata

evidenceobject · nullableOptional

Supporting evidence/attachments

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

get/activities/{id}
GET /api/activities/{id} HTTP/1.1
Accept: */*
{
  "id": 1,
  "timestamp": "2026-01-20T14:30:00.000Z",
  "type": "meeting",
  "subtype": "kickoff",
  "description": "Discussed project timeline and deliverables",
  "projectId": 1,
  "organizationId": 1,
  "creatorId": 5,
  "metadata": {},
  "evidence": {},
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "creator": {
    "id": 1,
    "username": "text",
    "fullName": "text"
  },
  "project": {
    "id": 1,
    "title": "text"
  }
}

List activities for a project

get

Returns all activities associated with a specific project

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
projectIdintegerRequired

Project ID

Responses
200

List of project activities

application/json
idintegerRequired

Unique activity identifier

Example: 1
timestampstring · date-timeRequired

When the activity occurred

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequired

Activity type

Example: meetingPossible values:
subtypestring · nullableOptional

Activity subtype for categorization

Example: kickoff
descriptionstringRequired

Activity description/content

Example: Discussed project timeline and deliverables
projectIdinteger · nullableOptional

Associated project ID

organizationIdinteger · nullableOptional

Associated organization ID

creatorIdintegerRequired

User ID who created the activity

Example: 5
metadataobject · nullableOptional

Additional activity metadata

evidenceobject · nullableOptional

Supporting evidence/attachments

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

get/projects/{projectId}/activities
GET /api/projects/{projectId}/activities HTTP/1.1
Accept: */*
[
  {
    "id": 1,
    "timestamp": "2026-01-20T14:30:00.000Z",
    "type": "meeting",
    "subtype": "kickoff",
    "description": "Discussed project timeline and deliverables",
    "projectId": 1,
    "organizationId": 1,
    "creatorId": 5,
    "metadata": {},
    "evidence": {},
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "creator": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    },
    "project": {
      "id": 1,
      "title": "text"
    }
  }
]

List activities for an organization

get

Returns all activities associated with a specific organization

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
organizationIdintegerRequired

Organization ID

Responses
200

List of organization activities

application/json
idintegerRequired

Unique activity identifier

Example: 1
timestampstring · date-timeRequired

When the activity occurred

Example: 2026-01-20T14:30:00.000Z
typestring · enumRequired

Activity type

Example: meetingPossible values:
subtypestring · nullableOptional

Activity subtype for categorization

Example: kickoff
descriptionstringRequired

Activity description/content

Example: Discussed project timeline and deliverables
projectIdinteger · nullableOptional

Associated project ID

organizationIdinteger · nullableOptional

Associated organization ID

creatorIdintegerRequired

User ID who created the activity

Example: 5
metadataobject · nullableOptional

Additional activity metadata

evidenceobject · nullableOptional

Supporting evidence/attachments

createdAtstring · date-timeRequired

Creation timestamp

updatedAtstring · date-timeRequired

Last update timestamp

get/organizations/{organizationId}/activities
GET /api/organizations/{organizationId}/activities HTTP/1.1
Accept: */*
[
  {
    "id": 1,
    "timestamp": "2026-01-20T14:30:00.000Z",
    "type": "meeting",
    "subtype": "kickoff",
    "description": "Discussed project timeline and deliverables",
    "projectId": 1,
    "organizationId": 1,
    "creatorId": 5,
    "metadata": {},
    "evidence": {},
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "creator": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    },
    "project": {
      "id": 1,
      "title": "text"
    }
  }
]

List comments on an activity

get

Returns all comments for a specific activity

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
activityIdintegerRequired

Activity ID

Responses
200

List of comments

application/json
idintegerRequired
contentstringRequired
activityIdinteger · nullableOptional
userIdintegerRequired
parentIdinteger · nullableOptional
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
get/activities/{activityId}/comments
GET /api/activities/{activityId}/comments HTTP/1.1
Accept: */*
[
  {
    "id": 1,
    "content": "text",
    "activityId": 1,
    "userId": 1,
    "parentId": 1,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "user": {
      "id": 1,
      "username": "text",
      "fullName": "text"
    }
  }
]

Add a comment to an activity

post

Creates a new comment on an activity

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
activityIdintegerRequired

Activity ID

Body
contentstringRequired

Comment content

parentIdinteger · nullableOptional

Parent comment ID for replies

Responses
200

Comment created successfully

application/json
idintegerRequired
contentstringRequired
activityIdinteger · nullableOptional
userIdintegerRequired
parentIdinteger · nullableOptional
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
post/activities/{activityId}/comments
POST /api/activities/{activityId}/comments HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "content": "text",
  "parentId": 1
}
{
  "id": 1,
  "content": "text",
  "activityId": 1,
  "userId": 1,
  "parentId": 1,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "user": {
    "id": 1,
    "username": "text",
    "fullName": "text"
  }
}

Add a tag to an activity

post

Associates a tag with an activity

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
activityIdintegerRequired

Activity ID

Body
tagIdintegerRequired

Tag ID to add

Responses
200

Tag added successfully

No content

post/activities/{activityId}/tags
POST /api/activities/{activityId}/tags HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "tagId": 1
}

No content

Remove a tag from an activity

delete

Removes the association between a tag and an activity

Authorizations
connect.sidstringRequired

Session-based authentication via HTTP-only cookie

Path parameters
activityIdintegerRequired

Activity ID

tagIdintegerRequired

Tag ID

Responses
204

Tag removed successfully

No content

delete/activities/{activityId}/tags/{tagId}
DELETE /api/activities/{activityId}/tags/{tagId} HTTP/1.1
Accept: */*

No content

Last updated

Was this helpful?