---
title: "GET /sm/describeTopic/{topic}"
method: GET
path: "/sm/describeTopic/{topic}"
tags: ["Secure Messaging"]
---

# GET /sm/describeTopic/{topic}

`GET /sm/describeTopic/{topic}`

## Request

- Base URL: `https://unifieddatalibrary.com`
- URL: `https://unifieddatalibrary.com/sm/describeTopic/{topic}`
- Auth: none declared

Retrieve the details of the specified topic or data type.

## Path parameters

- `topic` string, required

## Query parameters

- `firstResult` integer
- `maxResults` integer

## Response `200`

OK

- TopicDetails
  - `topic` string: The name of the topic in kafka.
  - `minPos` integer: The minimum (oldest) kafka offset for this topic.
  - `maxPos` integer: The maximum (latest) kafka offset for this topic.
  - `udlOpenAPISchema` string: The UDL schema that the objects in this topic apply to.
  - `description` string: A description of the data content of this topic.

## Other responses

- `400`: Bad Request
- `401`: Invalid/Missing User Credentials
- `403`: User Is Not Authorized
- `404`: Unable to reconcile topic:
- `429`: Rate of Requests Exceeds Allowed Limit
- `500`: Internal Server Error

## Changes

> 12 revisions in range; 1 could not be searched.

- **2025-09-26** `45631f9bb3f0`: 5 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `429`
  - …1 more
- **2025-05-29** `4e1cbc17e814`: 2 info
  - added the new optional `query` request parameter `firstResult`
  - added the new optional `query` request parameter `maxResults`
- **2025-04-16** `75f764c843a9`: 1 breaking, 1 warning
  - added the new path request parameter `topic`
  - deleted the `query` request parameter `topic`
- **2025-03-04** `53ced4917cd1`: 1 breaking, 1 warning
  - added the new required `query` request parameter `topic`
  - deleted the `path` request parameter `topic`

[Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/sm/describeTopic/:topic/get.md)

---

[API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)