---
title: "Get tracked items"
method: GET
path: "/api/crawl/settings"
tags: ["Crawl Settings"]
---

# Get tracked items

`GET /api/crawl/settings`

## Request

- Base URL: `https://api.xpoz.ai`
- URL: `https://api.xpoz.ai/api/crawl/settings`
- Auth: HTTP bearer

The caller's tracked keywords, users, subreddits, and hashtags per platform.

## Response `200`

Tracked items, or `{success: true, data: null, message}` when none are configured.

- union
  - CrawlSettings: Tracked items per platform.
    - `twitter` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `instagram` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
    - `reddit` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `subreddits` string[]
      - `users` string[]
    - `tiktok` object
      - `keywords` TrackedKeyword[]
        - union
          - string
          - object
            - `value` string, required
            - `country` string
      - `users` string[]
      - `hashtags` string[]
  - object
    - `success` true
    - `data` unknown
    - `message` string

## Other responses

- `401`: Missing or invalid credentials.
- `500`: Server error.

---

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