Skip to main content
Find agreements, invoices, alerts, topics and claims by name

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields, comma-separated. Fields: results.

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