# List Topics

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

Lists the topics of the workspace, oldest first. Needs a Full key. A key limited to one domain answers 403.

Lists are paged with cursors. Read `next_cursor` and send it as `after` for the next page. A page has 50 items unless you set `per_page`, up to 100.

## Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `per_page` | integer | No | How many items to return, from 1 to 100. Defaults to 50. |
| `after` | string | No | A `next_cursor` from the last page. Returns the items after it. |
| `before` | string | No | A `prev_cursor` from the last page. Returns the items before it. When you send both, `before` wins. |

## Response

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | The topics on this page. |
| `data[].id` | string | No | The topic id. |
| `data[].name` | string | No | The topic name. |
| `data[].description` | string \| null | No | Shown on the preference page. |
| `data[].default_subscribed` | boolean | No | Whether a new contact is subscribed until they choose. |
| `data[].visibility` | string | No | `public` or `private`. |
| `data[].double_opt_in` | boolean | No | Whether a form sign-up must confirm by email. |
| `data[].form_enabled` | boolean | No | Whether the hosted sign-up form is on. |
| `data[].sender_name` | string \| null | No | The from name for confirmation emails. |
| `data[].sender_email` | string \| null | No | The from address for confirmation emails. |
| `data[].redirect_url` | string \| null | No | The page shown after someone signs up. |
| `data[].is_default` | boolean | No | True for the default topic. Campaigns use it when no topic is set. |
| `data[].counts` | object | No | How many contacts chose each status. |
| `data[].counts.subscribed` | integer | No | Subscribed. |
| `data[].counts.pending` | integer | No | Waiting to confirm. |
| `data[].counts.unsubscribed` | integer | No | Unsubscribed. |
| `data[].created_at` | string | No | When it was created. |
| `data[].updated_at` | string | No | When it last changed. |
| `prev_cursor` | string \| null | No | Send it as `before` to get the page before. `null` on the first page. |
| `next_cursor` | string \| null | No | Send it as `after` to get the next page. `null` on the last page. |

## Request

cURL:

```bash
curl -X GET https://api.inboxjot.com/v1/topics \
  -H "Authorization: Bearer $INBOXJOT_API_KEY"
```

## Responses

| Status | Description |
| --- | --- |
| 200 | Returns a page of topics. |
| 400 | A parameter is missing or invalid. |
| 401 | The API key is missing, revoked or expired. |
| 403 | The key is a Sending key or is limited to one domain, or the request comes from outside its IP allowlist. |
| 429 | Too many requests for this key. Wait for the seconds in the Retry-After header. |
| 500 | Something failed on our side. Retry later. |

200:

```json
{
  "data": [
    {
      "id": "top_06d2mfk8r6pn2tc8yw3hd",
      "name": "Product updates",
      "description": "New features, once a month.",
      "default_subscribed": true,
      "visibility": "public",
      "double_opt_in": false,
      "form_enabled": false,
      "sender_name": null,
      "sender_email": null,
      "redirect_url": null,
      "is_default": false,
      "counts": {
        "subscribed": 3120,
        "pending": 14,
        "unsubscribed": 96
      },
      "created_at": "2026-09-02T10:12:00.000Z",
      "updated_at": "2026-09-02T10:12:00.000Z"
    }
  ],
  "prev_cursor": null,
  "next_cursor": null
}
```

400:

```json
{
  "name": "validation_error",
  "status": 400,
  "message": "Invalid cursor",
  "errors": [
    {
      "message": "Invalid cursor",
      "location": "after"
    }
  ],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

401:

```json
{
  "name": "unauthorized",
  "status": 401,
  "message": "Unauthorized",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

403:

```json
{
  "name": "forbidden",
  "status": 403,
  "message": "This key cannot be used from 203.0.113.7",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

429:

```json
{
  "name": "rate_limit_exceeded",
  "status": 429,
  "message": "Too many attempts. Try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```

500:

```json
{
  "name": "unknown_error",
  "status": 500,
  "message": "Something went wrong. Please try again later.",
  "errors": [],
  "request_id": "5f0c6a2e-8d1b-4c7a-9e3f-2b6d4a1c8e90"
}
```