# List topics (/docs/api-reference/topics/list-topics)

The subscription topics of the API key's environment.

`GET https://api.coss.com/v1/topics`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Query parameters

- `limit` (integer, 1-100): 1-100, default 50.
- `after` (string): Cursor: the `id` of the last item of the previous page.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.email.topics.list();
```

HTTP:

```sh
curl -X GET "https://api.coss.com/v1/topics" \
  -H "Authorization: Bearer $COSS_API_KEY"
```

Python:

```python
from coss import Coss

client = Coss()  # api_key= or COSS_API_KEY

client.email.topics.list()
```

Go:

```go
import (
	"context"

	cossclient "github.com/cosscom/coss-go/client"
	email "github.com/cosscom/coss-go/email"
)

client := cossclient.NewClient() // option.WithAPIKey(…) or COSS_API_KEY

request := &email.ListTopicsRequest{}
client.Email.Topics.List(
    context.TODO(),
    request,
)
```

Ruby:

```ruby
require "coss"

client = Coss::Client.new # api_key: or COSS_API_KEY

client.email.topics.list
```

PHP:

```php
<?php

use Coss\Coss;
use Coss\Email\Topics\Requests\ListTopicsRequest;

$client = new Coss(); // apiKey: or COSS_API_KEY

$client->email->topics->list(
    new ListTopicsRequest([]),
);
```

Java:

```java
import com.coss.Coss;
import com.coss.resources.email.topics.requests.ListTopicsRequest;

Coss client = Coss.builder().build(); // .apiKey(…) or COSS_API_KEY

client.email().topics().list(
    ListTopicsRequest
        .builder()
        .build()
);
```

.NET:

```csharp
using Coss;
using Coss.Email;

var client = new CossClient(); // apiKey: or COSS_API_KEY

await client.Email.Topics.ListAsync(new ListTopicsRequest());
```

## Response 200

A page of topics.

- `object` ("list", required)
- `data` (object[], required)
  - `object` ("topic", required)
  - `id` (string, required)
  - `key` (string, required): The `category` of the emails about this topic. Can't change.
  - `name` (string, required): Shown in the preference center.
  - `description` (string | null, required): Shown in the preference center under its name. `null`: none.
  - `default_subscription` ("opt_in" | "opt_out", required): `opt_in`: every subscribed contact gets the topic's emails unless they opt out. `opt_out`: only contacts who opted in do.
  - `visibility` ("public" | "private", required): `private` topics never show in the preference center.
  - `position` (integer, required): Order in the preference center (ascending).
  - `created_at` (string, required, date-time)
  - `updated_at` (string, required, date-time)
- `has_more` (boolean, required)

Example:

```json
{
  "object": "list",
  "data": [
    {
      "object": "topic",
      "id": "topic_01k7c8m4q2f3e9v6t5r1n0p8yz",
      "key": "newsletter",
      "name": "Newsletter",
      "description": "Monthly product news.",
      "default_subscription": "opt_in",
      "visibility": "public",
      "position": 0,
      "created_at": "2026-10-10T12:00:00.000Z",
      "updated_at": "2026-10-10T12:00:00.000Z"
    }
  ],
  "has_more": false
}
```

## Errors

- `400`: The `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `422`: A query parameter failed validation (`validation_error`, see `issues`).
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).