---
title: "Followed Keyword Lists"
method: GET
path: "/user/keyword_lists"
tags: ["Followed Keyword Lists"]
---

# Followed Keyword Lists

`GET /user/keyword_lists`

## Request

- Base URL: `https://public-api.apptweak.com/api/public/apptweak`
- URL: `https://public-api.apptweak.com/api/public/apptweak/user/keyword_lists`
- Auth: API key in header `x-apptweak-key`

Retrieve keyword lists grouped by workspace and by followed application configuration: store, country, language and device. <br/><br/> By default only list names and keyword counts are returned; pass `include_keywords=true` to also get the keywords themselves. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Comment</th><th>Credits/request</th></tr></thead> <tbody> <tr><td><b>Keyword list</b></td><td>Hash containing your keyword list by workspace and by app.</td><td>0</td></tr> </tbody> </table>

## Query parameters

- `workspace_ids` integer[], required
- `application_ids` string[]
- `stores` string[]
- `country_codes` string[]
- `language_codes` string[]
- `devices` string[]
- `include_keywords` boolean

## Response `200`

Successful response.

- object
  - `result` object
    - `summary` object
      - `keyword_list_count` integer
      - `keyword_count` integer
      - `unique_keyword_count` integer
    - `workspaces` object[]
      - `id` integer
      - `name` string
      - `followed_applications` object[]
        - `application_id` string
        - `application_name` string, nullable
        - `store` string
        - `country_code` string
        - `language_code` string
        - `device` string
        - `keyword_lists` object[]
          - `name` string
          - `keyword_count` integer
          - `keywords` string[]: Only present when `include_keywords=true`.
  - `metadata` ResponseMetadata: Standard response envelope: the request as the API parsed it, the credits actually charged (`cost`), and what the call could have cost had every datapoint been available (`max_credit_cost`). Every endpoint of this API returns it unchanged.
    - `request` object
      - `path` string: The path that was called.
      - `params` object, nullable: The query as the API parsed it, with defaults applied.
      - `cost` integer: Credits actually charged for this call.
      - `max_credit_cost` integer: Credits the call could have cost if every datapoint requested had been available.
      - `status` integer: HTTP status of the response.
    - `response` object, nullable: Endpoint-specific notes; null when there are none.

## Other responses

- `401`: Unauthorized. Unknown or missing API token.
- `403`: Forbidden. Not enough credits to perform the request.
- `422`: Validation error. Returned when a parameter is invalid.
- `429`: Rate limit exceeded: 20 requests per minute on this endpoint, 60 per 10 seconds across the API. Retry with backoff.

---

[API](https://skmtc.dev/apptweak/apis/apptweak-api.md) - [All operations](https://skmtc.dev/apptweak/apis/apptweak-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apptweak/apis/apptweak-api/revisions/76dfd41ade5d?raw)