Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
topics

Get topics

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.

get/topics

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
pageStartIndexinteger

Specifies the starting position for paginated results.

  • Default: 0 (first page) if not specified
  • Minimum: 0
  • Example: pageStartIndex=25 with pageSize=25 returns the second page of results

Response

list of topics

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.