Skip to main content
GET
Search memory
Requires read:memory for documents or read:operational-rules for rules. Each match includes the file path, the line and the layer: organization, firm or default. An incomplete search cannot show that a rule does not exist; follow next_cursor for more results. With kind=rule, query is a case-insensitive substring search across the rule text fields, including IDs, names and matchers. The results are complete and not paginated.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

kind
enum<string>
default:document

document (the default) for a memory document, or rule for an operational rule.

Available options:
document,
rule
query
string
required

Text to search for.

Required string length: 1 - 500
root
string

Document only.

scope
enum<string>

Document only.

Available options:
org,
firm
since
string<date-time>

Document only.

actor
string

Document only.

cursor
string

Document only. The next_cursor value from the previous page.

Maximum string length: 256
domain
enum<string>

Rule only. Limits the lookup to one rule domain.

Available options:
classification,
cash_application

Response

Matching lines with their path and source layer.

success
boolean
required

true when the request succeeded.

matches
object[]
required

Matching lines.

match_count
integer
required

Total matches found, which can exceed the number returned.

truncated
boolean
required

Some results were left out. Truncation does not show that a match is absent.

next_cursor
string | null
required

Pass as cursor with the same query and filters to continue.

other_number
object[]

Present when match_count is 0: lines that match the singular or plural form of the query.

unreadable
string[]

Paths skipped because their header did not parse.