---
title: "Get topics"
method: GET
path: "/topics"
tags: ["topics"]
---

# Get topics

`GET /topics`

## Request

- Base URL: `https://api.acculynx.com/webhooks/v2`
- URL: `https://api.acculynx.com/webhooks/v2/topics`
- Auth: HTTP bearer

Retrieves all available webhook topics you can subscribe to.

This endpoint returns a paginated list of all active topics, including:
- Topic names that you can use when creating or updating subscriptions
- Descriptions explaining what events each topic represents

Use this endpoint to discover what events you can receive through webhooks.

## Query parameters

- `pageSize` integer
- `pageStartIndex` integer

## Response `200`

list of topics

- TopicCollection: A paginated collection of available webhook topics. Contains both pagination metadata and the list of topics.
  - `count` integer: The total number of items available across all pages. Use this to calculate the total number of pages available.
  - `pageSize` integer: The number of items per page in this response. This reflects either your requested page size or the default value.
  - `pageStartIndex` integer: The starting index of this page of results. Use with pageSize to track your position in the overall result set.
  - `items` Topic[]: The list of topic objects for this page of results. Each item contains a topic name and description.
    - `description` string, required: Human-readable description of what this event represents. Helps you understand when this event will be triggered.
    - `topicName` string, required: The unique identifier for this topic. Use this exact string when creating or updating subscriptions.

## Other responses

- `400`: Bad Request - The server cannot process the request due to a client error. Common causes: - Invalid request format - Missing required fields - Validation errors in the request data
- `401`: Unauthorized - Authentication is required or has failed. Common causes: - Missing API key - Invalid API key - Expired or deactivated API key
- `416`: Range Not Satisfiable - The requested page of results is not available. Common causes: - pageStartIndex is beyond the available data range - Invalid pagination parameters

---

[API](https://skmtc.dev/acculynx/apis/webhooks-api.md) - [All operations](https://skmtc.dev/acculynx/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/webhooks-api/revisions/8bc7679859d8?raw)
