Skip to main content
POST
Credentials Global Search
This endpoint is subject to quotas and is subject to the Search ratelimiting tier. See Rate Limits and Quotas .
Flare supports searching in credentials via two endpoints:
Returns a list of credentials matching the query provided.

Paging

This endpoint supports the Flare standard paging pattern .

Body Parameters

size
number
Maximum size of the JSON object that will be returned (maximum 10 000)
from
string
The next value from the last response.
order
string
default:"desc"
The order in which the results will be returned. (asc or desc)
include
string[]
Additional fields to return. Available options:
  • known_password_id: ID of the credential’s password.
  • auth_domains: for each credential, up to 100 hosts (domain only, e.g. login.example.com) where the credential was seen being used.
query
object
One of the supported queries.
This query will match all credentials that contain the specified domain in the email address.
filters
object

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
DomainQuery · object
required
filters
CredentialsQueryFilters · object
from
string | null
size
integer
default:10
Required range: 1 <= x <= 10000
include
enum<string>[]
Available options:
known_password_id,
auth_domains,
urls
order
enum<string>
default:desc
Available options:
asc,
desc

Response

Successful Response

items
Credential · object[]
required
next
string | null
required