Skip to main content
Search structured prices for agreement assistant

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.

Path Parameters

id
string<uuid>
required

Body

application/json
query
string
Maximum string length: 500
search_fields
enum<string>[]
Minimum array length: 1
Available options:
product_code,
product_description,
product_group,
applies_to,
calculation_rules
price_type
enum<string>
Available options:
amount,
rate
item_numbers
integer[]
Maximum array length: 100
Required range: x >= 0
valid_in
string<date>
applies_to
string
Maximum string length: 500
product_group
string
Maximum string length: 500
unit_measure
string
Maximum string length: 500
currency
string
Maximum string length: 500
rate_basis
string
Maximum string length: 500
offset
integer
default:0
Required range: 0 <= x <= 10000
limit
integer
default:30
Required range: 1 <= x <= 100

Response

Bounded price matches and unfiltered scope size.

items
object[]
required
total_count
number
required
scope_total_count
number
required