Mail API reference

Mail API · Topics

get/v1/workspaces/{workspace_id}/topics/{topic_id}Auth

Get a topic

Path parameters

workspace_id*string · uuid

Id of the workspace.

topic_id*string · uuid

Id of the topic.

Response · 200

id*string · uuid

The topic id.

name*string

Display name of the topic, shown on the unsubscribe page.

Example: "Product updates"

description*string

Optional longer text shown under the name on the unsubscribe page.

default_subscription*object

Whether a contact who never chose is subscribed (`opt_in`) or not (`opt_out`).

visibility*object

`public` topics appear on the unsubscribe page; `private` ones do not.

created_at*string · date-time

When the topic was created.

updated_at*string · date-time

When the topic was last changed.

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/topics/{topic_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "Product updates",
  "description": "string",
  "default_subscription": {},
  "visibility": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}