---
title: "List custom categories"
method: GET
path: "/signal/custom_categories"
tags: ["signal"]
---

# List custom categories

`GET /signal/custom_categories`

Retrieve the team's Signal settings, the built-in categories, the team's custom categories with their example phrases, and calibration status.

## Headers

- `Authorization` string, required

## Response `200`

Categories, settings, and calibration

- SignalCustomCategoryListResponse
  - `success` boolean, required
  - `settings` SignalSettings
    - `use_builtin_categories` boolean — When false, scoring uses only the team's custom categories.
  - `built_in_categories` SignalBuiltInCategory[]
    - `id` integer
    - `name` string
    - `icon` string, nullable
    - `scenario_count` integer
    - `example_texts` string[]
  - `custom_categories` SignalCustomCategory[]
    - `id` integer
    - `name` string
    - `description` string, nullable
    - `icon` string, nullable
    - `enabled` boolean — Whether the category is included in scoring.
    - `status` 'pending' | 'embedding' | 'ready' | 'needs_more_examples' | 'failed'
    - `embed_error` string, nullable — Error message when `status` is `failed`.
    - `embedded_at` string, date-time, nullable
    - `scenario_count` integer
    - `embedding_model_version` string, nullable
    - `overlaps` SignalCustomCategoryOverlapsItems[] — Calibration warnings where this category was confused with another.
    - `scenarios` SignalScenario[]
      - `id` integer
      - `text` string
      - `embedded` boolean — Whether this example has finished embedding.
  - `calibration` SignalCalibration — Null until the team's categories have been calibrated.
    - `status` string
    - `calibrated_at` string, date-time, nullable
    - `overall_recall` number, double, nullable
    - `warnings` SignalCalibrationWarningsItems[]

## Other responses

- `403` — The account does not have Signal access

---

[API](https://skmtc.dev/resemble/apis/api-reference.md) · [All operations](https://skmtc.dev/resemble/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/resemble/api-reference/revisions/e93597a6b425/schema)