Skip to content
Cloudflare API
Start here
API Reference
Brand Protection
V2
Matches

List saved query matches

brand_protection.v2.matches.get(MatchGetParams**kwargs) -> MatchGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches

Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
Accepted Permissions (at least one required)
Cloudforce One WriteCloudforce One Read
ParametersExpand Collapse
account_id: str
minLength1
query_id: Sequence[str]

Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and dismissed state.

include_dismissed: Optional[str]
include_domain_id: Optional[str]
limit: Optional[str]
offset: Optional[str]
order: Optional[Literal["asc", "desc"]]

Sort order. Options: ‘asc’ (ascending) or ‘desc’ (descending)

One of the following:
"asc"
"desc"
order_by: Optional[Literal["domain", "first_seen", "registrar"]]

Column to sort by. Options: ‘domain’, ‘first_seen’, or ‘registrar’

One of the following:
"domain"
"first_seen"
"registrar"
ReturnsExpand Collapse
class MatchGetResponse: …
matches: List[Match]
domain: str
first_seen: str
public_scans: Optional[MatchPublicScans]
submission_id: str
registrar: Optional[str]
scan_status: str
scan_submission_id: Optional[int]
source: Optional[str]
dismissed: Optional[bool]

Whether the match is dismissed. Only present for single-query requests. For multi-query requests, use the dismissed field in each match_details entry.

match_details: Optional[List[MatchMatchDetail]]

Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested.

dismissed: bool

Individual dismissed state for this specific match.

match_id: int
query_id: int
query_tag: Optional[str]

Tag associated with the query, if one exists.

total: int
minimum0

List saved query matches

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
match = client.brand_protection.v2.matches.get(
    account_id="x",
    query_id=["string"],
)
print(match.matches)
{
  "matches": [
    {
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "registrar": "registrar",
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "dismissed": true,
      "match_details": [
        {
          "dismissed": true,
          "match_id": 0,
          "query_id": 0,
          "query_tag": "query_tag"
        }
      ]
    }
  ],
  "total": 0
}
Returns Examples
{
  "matches": [
    {
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "registrar": "registrar",
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "dismissed": true,
      "match_details": [
        {
          "dismissed": true,
          "match_id": 0,
          "query_id": 0,
          "query_tag": "query_tag"
        }
      ]
    }
  ],
  "total": 0
}