---
title: "Retrieve the topic catalog."
method: GET
path: "/topics"
tags: ["Topics"]
---

# Retrieve the topic catalog.

`GET /topics`

## Request

- Base URL: `https://api.maildroppa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maildroppa.com/topics`
- Auth: API key in header `X-API-Key`

Returns topics in catalog order with the default topic, subscriber counts and running enrollments.

## Query parameters

- `includeArchived` boolean

## Response `200`

Topic catalog.

- TopicCatalog: Topic catalog of the tenant in catalog order.
  - `defaultTopicId` string, uuid
  - `subscriberFacing` boolean: True once readers see topics, i.e. at least two topics are active.
  - `topics` Topic[]
    - `id` string, uuid
    - `label` string: Label shown to readers on forms and the preference page.
    - `description` string: Optional description shown to readers.
    - `position` integer: Catalog position; gaps are allowed.
    - `status` 'ACTIVE' | 'ARCHIVED'
    - `archivedAtUtc` string, date-time
    - `defaultTopic` boolean: Whether this is the tenant default topic.
    - `subscribedCount` integer: Subscribers currently subscribed to the topic.
    - `optedOutCount` integer: Subscribers who opted out of the topic themselves.
    - `enrollmentRunning` boolean: Whether existing subscribers are currently being enrolled into the topic.
    - `enrollment` TopicEnrollmentDto
      - `status` 'RUNNING' | 'COMPLETED' | 'FAILED'
      - `startedAtUtc` string, date-time
      - `addedSubscriberCount` integer

## Other responses

- `401`: Not Authorized
- `403`: Not Allowed
- `428`: Accept the customer agreements in the app before using API keys.

---

[API](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta.md) · [All operations](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/llms.txt) · [OpenAPI document](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/revisions/a9f5a3fd1fb0?raw)