Sign in
Emails::Topic

List Email Topics

List all email topics for a workspace. Use include_archived=true to include archived topics.

get/workspaces/{workspace_id}/emails/topics

Path parameters

workspace_idinteger required

Query parameters

include_archived'true'

Set to true to include archived topics in the results

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Topic ID

public_idstring nullable

Topic public ID

workspace_idinteger

Workspace ID

namestring

Topic name

descriptionstring nullable

Topic description

created_atstring date-time nullable

Created at datetime

updated_atstring date-time nullable

Updated at datetime

Example response

[
  {
    "id": 1,
    "public_id": "StUvWx",
    "workspace_id": 42000,
    "name": "Product Updates",
    "description": "Updates about our products",
    "created_at": "2025-01-01T00:00:00.000Z",
    "updated_at": "2025-01-01T00:00:00.000Z"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.