---
title: "system.kafka.listTopicPartitions"
description: "Returns a list of records that match the filter."
---

# system.kafka.listTopicPartitions

> Returns a list of records that match the filter.

This function is used in **Python Scripting**.

## Description
## Client Permission Restrictions
This scripting function has no [Client Permission](ignition-modules\vision\vision-project-properties\vision-project-properties.md#vision-permissions-properties) restrictions.

## Syntax
`system.kafka.listTopicPartitions(connector, topic, groupId, [options])`

### Parameters

| Type | Parameter | Description |
|---|---|---|
| String | `connector` | The name of the Kafka connector. |
| String | `topic` | The name of the Kafka topic. |
| String | `groupId` | The unique string of the consumer group the consumer belongs to. |
| Dictionary | `options` | Custom options specific to the consumer, with key value string pairs. Optional. |
    
### Returns
**List** - A list of records that match the filter.
    
### Scope
Gateway

## Code Examples
```python title="Example #1"
# Returns a list of records according to the parameter filters.
system.kafka.listTopicPartitions("MyKafkaConnector", "MyKafkaTopic", "consumer-group-one")
```