> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xpoz.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List tracked tweets

> Tweet tracking requests of the caller. Requires the `trackTweets` flag.



## OpenAPI

````yaml https://api.xpoz.ai/openapi.json get /api/crawl/tweet
openapi: 3.1.0
info:
  title: XPOZ API
  version: 1.0.0
  description: >-
    Social media data API for Twitter/X, Instagram, Reddit, and TikTok.


    **Data endpoints** (`/api/data/*`) are authenticated with an API access key
    and are metered against the account's credits. Most stored-data endpoints
    share the same query options: `fields` selects which attributes to return,
    `since`/`until` bound the date range, and `responseType` picks between a
    synchronous first page (`fast`), a full paged query run as a background
    operation (`paging`), and a CSV export (`csv`). `/live` endpoints fetch from
    the platform on demand and page with a cursor instead.


    **Account, billing, and crawl-settings endpoints** are used by the XPOZ
    dashboard and authenticate with the user's session.
servers:
  - url: https://api.xpoz.ai
    description: Production
security: []
tags:
  - name: Twitter (live)
    description: >-
      On-demand Twitter/X fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Instagram (live)
    description: >-
      On-demand Instagram fetches straight from the platform, cursor-paginated.
      Not available for trial access keys.
  - name: Reddit (live)
    description: >-
      On-demand Reddit fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: TikTok (live)
    description: >-
      On-demand TikTok fetches straight from the platform, cursor-paginated. Not
      available for trial access keys.
  - name: Operations
    description: Polling for background operations started with `responseType=paging`.
  - name: Account
    description: Access keys, plan, and usage of the signed-in user.
  - name: Billing
    description: Stripe checkout, subscription changes, and add-on purchases.
  - name: Crawl Settings
    description: Tracked items collected on a schedule.
  - name: System Status
    description: Platform status page and notifications.
  - name: Platform
    description: Health, metrics, and this spec.
paths:
  /api/crawl/tweet:
    get:
      tags:
        - Crawl Settings
      summary: List tracked tweets
      description: Tweet tracking requests of the caller. Requires the `trackTweets` flag.
      operationId: getCrawlTweet
      responses:
        '200':
          description: Requests.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TweetCrawlRequest'
        '401':
          $ref: '#/components/responses/UnauthorizedMessage'
        '403':
          $ref: '#/components/responses/NotAuthorized'
        '500':
          description: Server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyFailure'
      security:
        - UserSession: []
components:
  schemas:
    TweetCrawlRequest:
      type: object
      properties:
        id:
          type: string
        tweetId:
          type: string
        status:
          type: string
        endTime:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        createdAt:
          type: string
          format: date-time
      required:
        - id
        - tweetId
        - status
        - createdAt
    LegacyFailure:
      type: object
      properties:
        success:
          type: boolean
          const: false
        message:
          type: string
        error:
          type: string
      required:
        - success
        - message
    MessageError:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    ErrorField:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  responses:
    UnauthorizedMessage:
      description: Missing or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageError'
    NotAuthorized:
      description: Caller lacks the required admin feature flag or `@xpoz.ai` email.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorField'
  securitySchemes:
    UserSession:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Descope session JWT of a logged-in dashboard user. Send as
        `Authorization: Bearer <session JWT>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.