---
title: "List available tracker rules"
method: GET
path: "/v1/tracker/rules"
tags: ["Tracker"]
---

# List available tracker rules

`GET /v1/tracker/rules`

Returns all available tracker rule types with descriptions, configuration schemas, example configs, and example signal payloads. Use this to discover what rules exist before creating tracker lists. The response is deterministic — same output on every call.

<span>⚡ <strong>Rate limit:</strong> 120 requests per 1 minute</span>

<span>💰 <strong>Cost:</strong> FREE! No credits are charged for this API.&nbsp;<span title="Pricing shown is default pricing. Actual pricing may vary.">ⓘ</span></span>

## Query parameters

- `apiKey` string, required

## Response `200`

Default Response

- object
  - `output` object, required
    - `companyRules` object[], required — All available company tracking rule types.
      - `name` string, required — Rule type slug used in config objects (e.g. headcount_crossed_threshold).
      - `readableName` string, required — Human-readable name for this rule type.
      - `entityType` 'company' | 'person', required — Whether this rule applies to company or person lists.
      - `description` string, required — What change this rule detects and when it fires.
      - `useCase` string, required — Sales-oriented example of why you would use this rule.
      - `supportsInitialSignals` boolean, required — Whether this rule supports immediate initial signals on entity addition.
      - `config` object, required — Config schema and example for creating this rule type.
        - `schema` object, required — JSON Schema for the rule config object. Pass a config conforming to this schema when creating a tracker list rule.
        - `example` object, required — A valid example config you can pass directly to create a rule.
      - `signal` object, required — Signal output schema and example for this rule type.
        - `schema` object, required — JSON Schema for each item in the changeData array. When this rule fires, the signal contains one or more changeData items conforming to this schema.
        - `example` object, required — A concrete changeData item example matching the schema above.
    - `personRules` object[], required — All available person tracking rule types.
      - `name` string, required — Rule type slug used in config objects (e.g. headcount_crossed_threshold).
      - `readableName` string, required — Human-readable name for this rule type.
      - `entityType` 'company' | 'person', required — Whether this rule applies to company or person lists.
      - `description` string, required — What change this rule detects and when it fires.
      - `useCase` string, required — Sales-oriented example of why you would use this rule.
      - `supportsInitialSignals` boolean, required — Whether this rule supports immediate initial signals on entity addition.
      - `config` object, required — Config schema and example for creating this rule type.
        - `schema` object, required — JSON Schema for the rule config object. Pass a config conforming to this schema when creating a tracker list rule.
        - `example` object, required — A valid example config you can pass directly to create a rule.
      - `signal` object, required — Signal output schema and example for this rule type.
        - `schema` object, required — JSON Schema for each item in the changeData array. When this rule fires, the signal contains one or more changeData items conforming to this schema.
        - `example` object, required — A concrete changeData item example matching the schema above.
    - `totalRuleCount` integer, required — Total number of available rule types across both entity types.
  - `chargeInfo` union, required
    - object — Credits were charged immediately for this operation
      - `method` 'charged-now', required
      - `creditsCharged` number, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits will be charged after the operation completes
      - `method` 'charging-later', required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits that were charged for an asynchronous operation
      - `method` 'charged-for-async-process', required
      - `creditsCharged` number, required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — No credits were charged for this operation
      - `method` 'free', required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
    - object — Credits were refunded for this operation
      - `method` 'credits-refunded', required
      - `creditsRefunded` number, required
      - `message` string, required
      - `lowCreditAlert` object, nullable — Contains a link to get more credits, a warning message, and the remaining credit count.
        - `getMoreCreditsUrl` string, uri, required — URL to top up credits or restart billing cycle to get fresh credits.
        - `message` string, required — Human-readable credits warning.
        - `availableCredits` number, required — Number of credits remaining in the current billing period.
  - `warnings` object[], nullable — Warnings about extraneous fields in request
    - `field` string, required — Full path to extraneous field (e.g., 'searchParams.ExtraField')
    - `message` string, required — Warning message
  - `advice` string[], nullable — Tips, recommendations, and suggestions for using this API effectively.

## Other responses

- `400` — Default Response
- `401` — Default Response
- `402` — Default Response
- `403` — Default Response
- `404` — Default Response
- `422` — Default Response
- `429` — Default Response
- `500` — Default Response
- `503` — Default Response

---

[API](https://skmtc.net/fiber/apis/fiber-ai-api.md) · [All operations](https://skmtc.net/fiber/apis/fiber-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fiber/fiber-ai-api/versions/0c537984b99f/schema)
