Skip to main content
Search product records

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Query Parameters

query
string
required
Required string length: 1 - 200
types
string

Comma-separated entity types: agreement, invoice, alert, topic, claim. Omit to search all types.

limit_per_type
integer
default:5
Required range: 1 <= x <= 20

Response

Ranked search results.

results
object[]
required
Maximum array length: 100