latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

topics

Lists all topics of the specified workspace

You need workspaces.topic.get permission to access this resource

get/workspaces/{workspace_id}/topics

Path parameters

workspace_idstring required

Workspace identifier

Query parameters

page[size]integer

Amount of items per page

page[number]integer

Number of page you want to display

searchstring
Example:topic

Search topics by a word or a phrase contained in a title. Behavior is similar to operator LIKE in SQL. Case insensitive. Leading/following spaces are trimmed

Response

OK

metaobject required

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/topics/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "name": "Topic name"
      },
      "relationships": {
        "workspace": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/workspaces/5b4f337bff4304610483ba67"
          }
        },
        "user": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/users/5b4f337bff4304610483ba67"
          }
        }
      }
    }
  ]
}