---
title: "List topics"
method: GET
path: "/api/v1/topics"
tags: ["Topics"]
---

# List topics

`GET /api/v1/topics`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/v1/topics`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `topics:read`)

The subjects this project mails about, cursor-paginated and newest first.

Archived topics are omitted unless you ask for them with `include_archived`. Archiving is the retire button and there is no delete: a topic is where people's answers are recorded, so removing it would remove the choices they made.

`subscribed_count` counts contacts who explicitly said yes. It reads low on a topic with `default_opt_in` true, and that is the honest number — it is how many people answered, not how many would currently receive the mail.

Requires the `topics:read` scope — View the topics you mail about and who is subscribed to each.

## Query parameters

- `limit` integer
- `after` string: Opaque cursor from a previous response's `next_cursor`.
- `include_archived` boolean, nullable

## Response `200`

One page of topics

- TopicListV1: One page of the subjects this project mails about.
  - `data` TopicV1[], required
    - `archived` boolean, required: Hidden from the preference centre and from new sends, WITHOUT discarding the opt-outs recorded against it. There is no delete for the same reason: deleting a topic would delete the choices people made about it.
    - `created_at` string, date-time, required
    - `default_opt_in` boolean, required: What a contact with NO answer counts as. True is the honest default for a topic added after a list already exists: those contacts consented to hear from you, and inventing an opt-out they never asked for would silence mail they expect. False means the topic must be opted INTO, and absence means `not asked` rather than `no`.
    - `description` string, nullable, required
    - `id` string, required
    - `key` string, required: Stable, URL-safe, unique within the project. This is what a preference form and an API caller name the topic by, so it must survive a rename of `name` — which is the whole reason it exists beside one.
    - `name` string, required
    - `subscribed_count` integer, required: Contacts who explicitly said yes. Excludes those covered only by `default_opt_in`.
    - `unsubscribed_count` integer, required
  - `has_more` boolean, required
  - `next_cursor` string, nullable, required: Pass as `after` to fetch the next page. `null` on the last page.

## Other responses

- `401`: `invalid_api_key` or `invalid_session` — missing or invalid credentials.
- `403`: `scope_missing`, `project_access_denied`, or `project_disabled`.
- `422`: `validation_error` — query, path, or body parameters did not match the schema.
- `429`: `rate_limited` — see `Retry-After` and the `RateLimit` headers.
- `500`: `internal_error`.

---

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