Skip to content

Topics

Get all topics

Section titled “ Get all topics ”
GET v3/projects/23423233/topics returns all topics for the specified project. 
[
  {
    "id": 25299755,
    "title": "Introduction",
    "description": "Introduction for discussing the marketing process",
    "private": false,
    "archived": false,
    "pinned": false,
    "comments": {
      "count": 0
    },
    "assigned": [
      12009183,
      11679192
    ],
    "project": {
      "id": 23423233
    }
  },
  {
    "id": 25299972,
    "title": "Marketing Strategy",
    "description": "Topic to discuss the marketing strategy for PH",
    "private": false,
    "archived": false,
    "pinned": true,
    "comments": {
      "count": 2
    },
    "attachments": 2
  }
]

Get topic

Section titled “ Get topic ”
GET v3/projects/23423233/topics/25299972 returns the specified topic. 
{
  "id": 25299972,
  "title": "Marketing Strategy",
  "description": "Topic to discuss the marketing strategy for PH",
  "private": false,
  "pinned": true,
  "archived": false,
  "comments": {
    "count": 2
  },
  "attachments": [
    {
      "id": 50085572,
      "name": "sample.png",
      "file_type": "png"
    }
  ],
  "assigned": [
    1176508223
  ],
  "project": {
    "id": 23423233
  }
}

The topic response includes attachment metadata, comment count, assignment information, and project details.

Create topic

Section titled “ Create topic ”
POST v3/projects/23423233/topics creates a new discussion topic. 
{
  "title": "New topic for discussion",
  "description": "Topic content...",
  "private": true,
  "assigned": [
    12009183,
    11679192
  ]
}

The assigned array is optional and accepts People IDs.

201 Created is returned along with the created topic. 403 Forbidden is returned if access is denied.

Attaching files

Section titled “ Attaching files ”

Files can be attached to a topic using attachment IDs obtained from the Attachments API. 

{
  "title": "New topic for discussion",
  "description": "Topic content...",
  "private": true,
  "attachments": [
    {
      "id": 123456
    }
  ],
  "assigned": [
    12009183,
    11679192
  ]
}

Multiple attachments are supported. Attachment IDs must be created through the Attachments API before they can be associated with a topic.

Update topic

Section titled “ Update topic ”
PUT v3/projects/23423233/topics/25299755 updates the specified topic. 
{
  "title": "Modify the topic for discussion",
  "description": "Topic content...",
  "private": true,
  "assigned": [
    12009183,
    11679192
  ]
}
200 OK is returned along with the updated topic. 403 Forbidden is returned if access is denied.

Delete topic

Section titled “ Delete topic ”
DELETE v3/projects/23423233/topics/25299755 deletes the specified topic.

Deleting a topic permanently removes the discussion and its associated comments.

204 No Content is returned if the topic is deleted successfully. 403 Forbidden is returned if access is denied.