{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Reference","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-reference","__idx":0},"children":["API Reference"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The iClosed.io API is documented with OpenAPI 3.0. Use the spec for code generation, Postman/Insomnia import, or interactive docs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"openapi-spec","__idx":1},"children":["OpenAPI spec"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Spec file:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/v1/openapi"},"children":["openapi/v1/openapi.json"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"viewing-with-redocly","__idx":2},"children":["Viewing with Redocly"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This project is wired for ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://redocly.com/docs/cli/"},"children":["Redocly CLI"]},". From the repo root (use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nvm use 22"]}," if you use nvm):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Lint the API spec\nnpx @redocly/cli lint\n\n# Preview the API reference (interactive docs) — serves at http://localhost:8080\nnpx @redocly/cli preview-docs iclosed@v1\n\n# Custom port, e.g. 3000\nnpx @redocly/cli preview-docs iclosed@v1 -p 3000\n\n# Bundle the spec (outputs bundled file)\nnpx @redocly/cli bundle openapi/v1/openapi.json -o openapi/v1/bundled.json\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configuration is in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/redocly.bcc0316026b40a9f9380deefb032a6a4c19dd2a905c9e93016c20256211c3bd4.8a5edab2.yaml"},"children":["redocly.yaml"]}," at the project root. The API is registered as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iclosed@v1"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"host-locally","__idx":3},"children":["Host locally"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What"},"children":["What"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Command"},"children":["Command"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reunite/Realm"]}," (full theme, sidebar, API + docs)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm run preview"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm run preview:reunite"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["http://localhost:4000"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API reference only"]}," (Redoc)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm run preview:api"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli preview-docs iclosed@v1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["http://localhost:9999"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Docs"]}," (markdown only)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm run preview:docs"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx serve docs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["http://localhost:3000"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["To see how it will look when Redocly hosts it"]}," (navbar, footer, theme, sidebar): run ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npm run preview"]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["npx @redocly/cli preview --product=realm"]},"). That uses the same Realm layout and theme as Reunite."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-docs","__idx":4},"children":["Related docs"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/"},"children":["Introduction"]}," — Base URLs, first request, endpoint quick reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/authentication"},"children":["Authentication"]}," — API keys and headers"]}]}]},"headings":[{"value":"API Reference","id":"api-reference","depth":1},{"value":"OpenAPI spec","id":"openapi-spec","depth":2},{"value":"Viewing with Redocly","id":"viewing-with-redocly","depth":2},{"value":"Host locally","id":"host-locally","depth":2},{"value":"Related docs","id":"related-docs","depth":2}],"frontmatter":{"seo":{"title":"API Reference"}},"lastModified":"2026-03-25T12:33:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}