Skip to main content
Query agreement records for the organization 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.

Body

application/json
where
any

Resolved filter AST with at most three group levels and 20 conditions.

Required string length: 1 - 200
order_by
object
limit
integer
default:20
Required range: 1 <= x <= 50
offset
integer
default:0
Required range: 0 <= x <= 1000
include_total
boolean
default:false
include_documents
boolean
default:false

Response

Agreement query page.

items
object[]
required
has_more
boolean
required
total_count
number | null
required
scope_total_count
number | null
required