---
title: "Whitelist Matches"
method: GET
path: "/api/admin/whitelist/{rule_id}/matches"
tags: ["Admin - Whitelist"]
---

# Whitelist Matches

`GET /api/admin/whitelist/{rule_id}/matches`

Return the users currently matched by a specific whitelist rule.

Data source is the cached Supabase auth email map + platform user_profiles
for full names, so the query is cheap even with many rules on the page.

## Path parameters

- `rule_id` string, required

## Response `200`

Successful Response

- WhitelistMatchesResponse
  - `success` boolean
  - `rule_id` string, required
  - `pattern` string, required
  - `matches` WhitelistMatchedUser[]
    - `user_id` string, required
    - `email` string, required
    - `full_name` string, nullable
    - `company_name` string, nullable
  - `total` integer

## Other responses

- `422` — Validation Error

---

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