Topics
GET
List Topics
GET /v1/topicsRetrieve a paginated list of all topics in your workspace.
Use Cases:
- Display topic subscription preferences to contacts
- Build subscription management pages
- Export topic configuration
- Sync topics with external systems
- Generate topic analytics and reports
Behavior:
- Returns all topics in alphabetical order by name
- Uses cursor-based pagination for efficient retrieval
- Includes topic metadata (name, description, slug)
- Shows subscriber counts for each topic
- Maximum 100 topics per request
- Includes both active and archived topics
Required Scope: read:topics
Response Includes:
- Topic ID and slug (URL-safe identifier)
- Name and description
- Subscriber count (active subscriptions)
- Creation and update timestamps
- Visibility settings (public/private)
Use Topics For:
- Newsletter categories (e.g., "Product Updates", "Marketing Tips")
- Interest-based segmentation
- Preference center organization
- Compliance with subscription preferences
- Multi-channel communication preferences
Query parameters
limitintegerNumber of items to return (default: 20, max: 100)
afterstringCursor for pagination - ID of the last item from the previous page
beforestringCursor for reverse pagination - ID of the first item from the next page
Response
200Successfully retrieved paginated list of topics with metadata and subscriber counts
objectstringrequiredhasMorebooleanrequireddataobject[]required