---
title: List topic events
slug: topic-api/list-topic-events
docTags: 
createdAt: 2024-06-10T16:49:07.009Z
---

{
  "id": "sTu8tAmgJ8E_DdOjLyQ1B",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events",
    "servers": [
      {
        "url": "https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events"
      }
    ],
    "name": "List topic events",
    "description": "List all events for a topic.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "topic-board-id",
          "type": "string",
          "example": "e18a2d10-1595-4e52-a941-22d43bf8d7ad",
          "description": "Id of the topic board"
        },
        {
          "kind": "required",
          "name": "topic-id",
          "type": "string",
          "example": "18d0273d-e15c-4924-97b3-6f47b233eebe",
          "description": "Topic id"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ]
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "topic-event[]",
            "schema": [
              {
                "name": "topic_guid",
                "kind": "optional",
                "type": "string",
                "description": "Id of topic where event occurred",
                "example": "18d0273d-e15c-4924-97b3-6f47b233eebe"
              },
              {
                "name": "date",
                "kind": "optional",
                "type": "string",
                "description": "Date when event occurred",
                "example": "2023-11-15T12:10:17.000+0000"
              },
              {
                "name": "author",
                "kind": "optional",
                "type": "string",
                "description": "User name that triggered the event",
                "example": "john@doe.com"
              },
              {
                "name": "actions",
                "kind": "optional",
                "type": "array",
                "description": "List of actions involved in the event",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "type",
                    "kind": "optional",
                    "type": "string<assigned_to_removed | assigned_to_updated | description_removed | description_updated | due_date_removed | due_date_updated | label_added | label_removed | priority_removed | priority_updated | status_updated | title_updated | topic_created | type_updated>",
                    "description": "The type of action, valid values are:\n  - assigned_to_removed\n  - assigned_to_updated\n  - description_removed\n  - description_updated\n  - due_date_removed\n  - due_date_updated\n  - label_added\n  - label_removed\n  - priority_removed\n  - priority_updated\n  - status_updated\n  - title_updated\n  - topic_created\n  - type_updated\n",
                    "example": "title_updated"
                  },
                  {
                    "name": "value",
                    "kind": "optional",
                    "type": "string",
                    "description": "Value associated with event if applicable",
                    "example": "629a9b4e36ac4e68a05aedbcb21f53c0"
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/topic-event",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "w3Vm5TdOhWR9Rs-q53MzD",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events \\\n     --header 'accept: application/json'"
        },
        {
          "id": "HO-1RjtDcGDittLxbMLiD",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "SL1PcQCuZ_0JsYKbsQVA0",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "M2pzDa7-KxOVPu8dVwZLY",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/opencde/bcf/3.0/projects/{topic-board-id}/topics/{topic-id}/events\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "w3Vm5TdOhWR9Rs-q53MzD"
    },
    "results": {
      "languages": [
        {
          "id": "6WP3AytdxhjSkTXCoVrRj",
          "language": "200",
          "code": "// OK\n[\n  {\n    \"topic_guid\": \"18d0273d-e15c-4924-97b3-6f47b233eebe\",\n    \"date\": \"2023-11-15T12:10:17.000+0000\",\n    \"author\": \"john@doe.com\",\n    \"actions\": [\n      {\n        \"type\": \"title_updated\",\n        \"value\": \"629a9b4e36ac4e68a05aedbcb21f53c0\"\n      }\n    ]\n  }\n]"
        }
      ],
      "selectedLanguageId": "6WP3AytdxhjSkTXCoVrRj"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}