---
title: "List keywords"
description: "Returns the workspace's keywords with their match counts and polling status. With no parameters you get all keywords, latest first. `q` searches the term and context. `kind`, `status` and `platform` filter the list, `sort` orders it, and `limit` and `offset` page through it. `total` is the number of matching keywords before paging."
canonical: https://docs.rumoro.dev/api/keywords/list-keywords
markdown: https://docs.rumoro.dev/api/keywords/list-keywords.mdx
---

# List keywords

`GET /v1/keywords`

Returns the workspace's keywords with their match counts and polling status. With no parameters you get all keywords, latest first. `q` searches the term and context. `kind`, `status` and `platform` filter the list, `sort` orders it, and `limit` and `offset` page through it. `total` is the number of matching keywords before paging.

## Parameters

| Name | In | Description |
| --- | --- | --- |
| `q` | query | Case-insensitive search in the term and context. |
| `groupId` | query | Keeps keywords in these groups only (grp_...). Repeat the parameter or separate values with commas. |
| `kind` | query | Keeps keywords of these kinds only (brand, competitor, topic). Repeat the parameter or separate values with commas. |
| `status` | query | Keeps keywords in these states only (active, muted, paused, capped). Repeat the parameter or separate values with commas. |
| `platform` | query | Keeps keywords that run on one of these platforms. That means the term is searched there, which is every platform when platforms is null. For appstore and googleplay it means an app from that store is in reviewSources. Repeat the parameter or separate values with commas. |
| `sort` | query | newest puts the latest created first and oldest the earliest. term sorts A to Z. mentions puts the most matches first and relevant the most relevant matches. recent puts the most matches of the past 7 days first. lastMention puts the latest matched post first, with keywords that have none at the end. |
| `limit` | query | How many to return, from 1 to 500. Leave it out to get all keywords after `offset`. |
| `offset` | query | How many keywords to skip. |

## Responses

| Status | Meaning |
| --- | --- |
| 200 | The keywords that match, with their total |
| 400 | A query parameter is not valid |
| 401 | The API key is missing or not valid |

The [OpenAPI document](https://api.rumoro.dev/v1/openapi.json) has every schema. Rules shared by all endpoints are in [Conventions](https://docs.rumoro.dev/conventions.mdx).