Skip to main content
GET
Search brands
1 credit Free on Pro, Growth, and Scale See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Query Parameters

query
string
required

Search term, matched against the fields selected by queryBy (e.g. 'stripe', 'stripe.com', 'stri').

Required string length: 1 - 100
autocomplete
boolean
default:true

Whether the search term matches by prefix, so partial words match as they are typed (e.g. 'stri' matches Stripe). Set to false to match whole words only.

queryBy
enum<string>[]

Fields to match the search term against, as a comma-separated list or repeated parameter: 'name', 'domain', or both. Defaults to both.

Minimum array length: 1
Available options:
name,
domain
typoTolerance
integer
default:0

Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no typo tolerance).

Required range: 0 <= x <= 2
tags
string[]

Comma-separated labels for filtering usage, e.g. production,team-alpha. Labels for filtering usage in the dashboard.

Maximum array length: 20
Required string length: 1 - 50
Example:

Response

Successful response

results
object[]
required

Up to 10 matching brands, name matches first, then domain matches, most popular first within each group. Empty when nothing matches.

Maximum array length: 10
request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

key_metadata
object

Credits this request used and your remaining balance.