Search text across every document in the org

Tolerant exact-text search across the org's documents (ignores smart-quote, dash, and whitespace differences). Pass document_ids to narrow the scope; omit it to search every document, capped at 25.

POST /documents/search

Headers

Authorization string Required
Bearer <session token>: the signed-in user’s Scaffold session token.
x-org-id string Required

Body

query string Required
document_ids string[]
Optional document or series ids to restrict the search to.
case_sensitive boolean
Default false
limit_per_document integer
Default 3

cURL Node Python

curl -X POST "https://api.scaffoldyourdocs.com/documents/search" \
  -H "Authorization: Bearer <session token>" \
  -H "x-org-id: org_example" \
  -H "Content-Type: application/json" \
  -d '{"query":"text"}'

const response = await fetch("https://api.scaffoldyourdocs.com/documents/search", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <session token>",
    "x-org-id": "org_example",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({"query":"text"})
});

import requests

response = requests.post(
    "https://api.scaffoldyourdocs.com/documents/search",
    headers={
        "Authorization": "Bearer <session token>",
        "x-org-id": "org_example",
        "Content-Type": "application/json"
    },
    json={"query": "text"},
)