Search by Address — You can look up a report without knowing the ID by passing ?address= as a query parameter. The address lookup takes priority over the path ID, so you can use any placeholder (e.g. search) in the URL.
GET /v1/reports/search?address=123 Main St
Address matching is partial and case-insensitive and handles common abbreviations automatically (e.g. St = Street, Ave = Avenue, APT = Unit).
The report UUID. If searching by address, you can use any placeholder value (e.g., "search" or "by-address").
The address query parameter will override this value.
Search for a report by address instead of using reportId.
If provided, this will override the reportId path parameter.
Supports partial matching (case-insensitive).
Example: "123 Main St" or "Main Street"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"North Reports API","colors":{"primary":"#2563EB","light":"#3B82F6","dark":"#1D4ED8"},"favicon":"/favicon.svg","api":{},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://northreports.com/dashboard"}},"footer":{"socials":{"website":"https://northreports.com"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://northreports.com/dashboard"},{"anchor":"Support","icon":"envelope","href":"https://northreports.com/support"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"north","hasAudioNarration":false,"actualSubdomain":"north","customDomains":["docs.northreports.com"],"gitSource":{"type":"github","owner":"dcauldy","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20ce078a6a521d8eaf8a82","collectionId":"c6531974-589e-48bf-a891-74ac2acd4af0","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae942027db8e62ea82afa2a:success","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"Reports","count":7},{"language":"default","tag":"Comparables","count":5},{"language":"default","tag":"Showings","count":5},{"language":"default","tag":"Webhooks","count":5},{"language":"default","tag":"Documentation","count":3},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Guides","count":2},{"language":"default","tag":"Integrations","count":2},{"language":"default","tag":"Users","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/reports/get-report","slug":"/api-reference/reports/get-report","pageMetadata":{"title":"Get Report","openapi":"GET /v1/reports/{reportId}","description":"Retrieve a single North Report by ID or by property address.","href":"/api-reference/reports/get-report","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a single North Report by ID or by property address.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Info}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Search by Address`}),` — You can look up a report without knowing the ID by passing `,_jsx(_components.code,{children:`?address=`}),` as a query parameter. The address lookup takes priority over the path ID, so you can use any placeholder (e.g. `,_jsx(_components.code,{children:`search`}),`) in the URL.`]}),_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`GET /v1/reports/search?address=123 Main St`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),_jsxs(_components.p,{children:[`Address matching is `,_jsx(_components.strong,{children:`partial and case-insensitive`}),` and handles common abbreviations automatically (e.g. `,_jsx(_components.code,{children:`St`}),` = `,_jsx(_components.code,{children:`Street`}),`, `,_jsx(_components.code,{children:`Ave`}),` = `,_jsx(_components.code,{children:`Avenue`}),`, `,_jsx(_components.code,{children:`APT`}),` = `,_jsx(_components.code,{children:`Unit`}),`).`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Report","openapi":"GET /v1/reports/{reportId}","description":"Retrieve a single North Report by ID or by property address.","href":"/api-reference/reports/get-report","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getReport","summary":"Get a specific report","description":"Retrieve a single North Report by ID or by property address.","tags":["Reports"],"parameters":["b3bbefa5-b31a-4d57-8234-3a5127545bb8","947d6d85-c826-4c8b-8651-08074d162d17"],"responses":{"200":"1924eb09-038a-4a8d-abf1-f248dbd5527d","401":"d3e8710f-057e-40f2-b554-3cbbc7bea6d7","403":"efbd7b15-9e8a-40ab-8965-a52a4861a311","404":"2b7739c1-2ccd-4079-a6ce-56c591389239","429":"fe9b47ae-71de-4901-a288-375226a70351"},"method":"get","type":"path","servers":["cbf2641a-d12e-4dda-8508-deb60c806f6b"],"security":["f68b0bbf-4a22-415e-923c-e1c9da9574c1"],"path":"/v1/reports/{reportId}","baseUrlOptions":["https://api.northreports.com"],"title":"Get a specific report","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b3bbefa5-b31a-4d57-8234-3a5127545bb8":{"name":"reportId","in":"path","required":true,"description":"The report UUID. If searching by address, you can use any placeholder value (e.g., \"search\" or \"by-address\").\nThe address query parameter will override this value.\n","schema":{"type":"string","isRequired":true,"description":"The report UUID. If searching by address, you can use any placeholder value (e.g., \"search\" or \"by-address\").\nThe address query parameter will override this value.\n","uniqueKey":"","typeLabel":"string"}},"947d6d85-c826-4c8b-8651-08074d162d17":{"name":"address","in":"query","required":false,"description":"Search for a report by address instead of using reportId.\nIf provided, this will override the reportId path parameter.\nSupports partial matching (case-insensitive).\nExample: \"123 Main St\" or \"Main Street\"\n","schema":{"type":"string","isRequired":false,"description":"Search for a report by address instead of using reportId.\nIf provided, this will override the reportId path parameter.\nSupports partial matching (case-insensitive).\nExample: \"123 Main St\" or \"Main Street\"\n","uniqueKey":"","typeLabel":"string"}}},"responses":{"1924eb09-038a-4a8d-abf1-f248dbd5527d":{"description":"Successfully retrieved report","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"address":{"type":"string","uniqueKey":"data.address","typeLabel":"string"},"city":{"type":"string","uniqueKey":"data.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"data.state","typeLabel":"string"},"zip":{"type":"string","uniqueKey":"data.zip","typeLabel":"string"},"price":{"type":"number","uniqueKey":"data.price","typeLabel":"number"},"beds":{"type":"integer","uniqueKey":"data.beds","typeLabel":"integer"},"baths":{"type":"number","uniqueKey":"data.baths","typeLabel":"number"},"sqft":{"type":"integer","uniqueKey":"data.sqft","typeLabel":"integer"},"year_built":{"type":"integer","uniqueKey":"data.year_built","typeLabel":"integer"},"property_type":{"type":"string","uniqueKey":"data.property_type","typeLabel":"string"},"status":{"type":"string","uniqueKey":"data.status","typeLabel":"string"},"is_published":{"type":"boolean","uniqueKey":"data.is_published","typeLabel":"boolean"},"is_draft":{"type":"boolean","uniqueKey":"data.is_draft","typeLabel":"boolean"},"published_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"data.published_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"data.published_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.published_at","typeLabel":"string\u003cdate-time> | null"},"views_count":{"type":"integer","uniqueKey":"data.views_count","typeLabel":"integer"},"saves_count":{"type":"integer","uniqueKey":"data.saves_count","typeLabel":"integer"},"showings_count":{"type":"integer","uniqueKey":"data.showings_count","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.description","typeLabel":"string | null"},"lot_size":{"oneOf":[{"type":"number","uniqueKey":"data.lot_size.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"data.lot_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.lot_size","typeLabel":"number | null"},"zillow_url":{"oneOf":[{"type":"string","uniqueKey":"data.zillow_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.zillow_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.zillow_url","typeLabel":"string | null"},"zpid":{"oneOf":[{"type":"string","uniqueKey":"data.zpid.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.zpid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.zpid","typeLabel":"string | null"},"mls_id":{"oneOf":[{"type":"string","uniqueKey":"data.mls_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.mls_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.mls_id","typeLabel":"string | null"},"listing_agent":{"oneOf":[{"type":"string","uniqueKey":"data.listing_agent.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.listing_agent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.listing_agent","typeLabel":"string | null"},"created_by":{"oneOf":[{"type":"string","uniqueKey":"data.created_by.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.created_by","typeLabel":"string | null"},"executive_summary":{"oneOf":[{"type":"string","uniqueKey":"data.executive_summary.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.executive_summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.executive_summary","typeLabel":"string | null"},"show_comps_on_report":{"type":"boolean","uniqueKey":"data.show_comps_on_report","typeLabel":"boolean"},"show_neighborhood_on_report":{"type":"boolean","uniqueKey":"data.show_neighborhood_on_report","typeLabel":"boolean"},"show_social_on_report":{"type":"boolean","uniqueKey":"data.show_social_on_report","typeLabel":"boolean"},"show_showings_on_report":{"type":"boolean","uniqueKey":"data.show_showings_on_report","typeLabel":"boolean"},"show_agent_insights_on_report":{"type":"boolean","uniqueKey":"data.show_agent_insights_on_report","typeLabel":"boolean"},"comparable_properties":{"type":"array","items":{"type":"object","uniqueKey":"data.comparable_properties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.comparable_properties","typeLabel":"object[]"},"showing_events":{"type":"array","items":{"type":"object","uniqueKey":"data.showing_events.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.showing_events","typeLabel":"object[]"},"social_media_posts":{"type":"array","items":{"type":"object","uniqueKey":"data.social_media_posts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.social_media_posts","typeLabel":"object[]"},"agent_insights":{"type":"array","items":{"type":"object","uniqueKey":"data.agent_insights.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.agent_insights","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","address":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>","price":123,"beds":123,"baths":123,"sqft":123,"year_built":123,"property_type":"\u003cstring>","status":"\u003cstring>","is_published":true,"is_draft":true,"published_at":"2023-11-07T05:31:56Z","views_count":123,"saves_count":123,"showings_count":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","description":"\u003cstring>","lot_size":123,"zillow_url":"\u003cstring>","zpid":"\u003cstring>","mls_id":"\u003cstring>","listing_agent":"\u003cstring>","created_by":"\u003cstring>","executive_summary":"\u003cstring>","show_comps_on_report":true,"show_neighborhood_on_report":true,"show_social_on_report":true,"show_showings_on_report":true,"show_agent_insights_on_report":true,"comparable_properties":[{}],"showing_events":[{}],"social_media_posts":[{}],"agent_insights":[{}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"d3e8710f-057e-40f2-b554-3cbbc7bea6d7":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"error.status","typeLabel":"integer"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Invalid API key","status":401}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Invalid API key","status":401}}}},"exampleType":"examples"}},"exampleType":"examples"},"efbd7b15-9e8a-40ab-8965-a52a4861a311":{"description":"API key lacks required permission","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"error.status","typeLabel":"integer"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Permission denied: reports:create","status":403}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Permission denied: reports:create","status":403}}}},"exampleType":"examples"}},"exampleType":"examples"},"2b7739c1-2ccd-4079-a6ce-56c591389239":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"error.status","typeLabel":"integer"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Report not found","status":404}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Report not found","status":404}}}},"exampleType":"examples"}},"exampleType":"examples"},"fe9b47ae-71de-4901-a288-375226a70351":{"description":"Too many requests","headers":{"X-RateLimit-Limit":{"schema":{"type":"integer"},"description":"Request limit per hour"},"X-RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Remaining requests in current window"},"X-RateLimit-Reset":{"schema":{"type":"integer"},"description":"Unix timestamp when the rate limit resets"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"status":{"type":"integer","uniqueKey":"error.status","typeLabel":"integer"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Rate limit exceeded. Please try again later.","status":429}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Rate limit exceeded. Please try again later.","status":429}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f68b0bbf-4a22-415e-923c-e1c9da9574c1":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key authentication. Include your API key in the Authorization header:\n```\nAuthorization: Bearer north_sk_live_xxxxxxxxxxxx\n```\n","scopes":[]}}},"servers":{"cbf2641a-d12e-4dda-8508-deb60c806f6b":{"url":"https://api.northreports.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication. Include your API key in the Authorization header:\n```\nAuthorization: Bearer north_sk_live_xxxxxxxxxxxx\n```\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication. Include your API key in the Authorization header:\n```\nAuthorization: Bearer north_sk_live_xxxxxxxxxxxx\n```\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"north","siteName":"North Reports API","title":"Get Report - North Reports API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-06T20:05:01.163Z","originalFileLocation":"api-reference/reports/get-report.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a single North Report by ID or by property address.\">\u003cmeta data-mint-head name=\"application-name\" content=\"North Reports API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Report - North Reports API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single North Report by ID or by property address.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"North Reports API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.northreports.com/api-reference/reports/get-report\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://north.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+Report\u0026amp;description=Retrieve+a+single+North+Report+by+ID+or+by+property+address.\u0026amp;theme=85f832f8b30837d0268a5e67\u0026amp;signature=14479b33ef623cce35f43d588b746054da816765cc7bc723fe9cbb8e343b6f41\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Report - North Reports API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single North Report by ID or by property address.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://north.mintlify.app/_mintlify/api/og/v2?division=Reports\u0026amp;title=Get+Report\u0026amp;description=Retrieve+a+single+North+Report+by+ID+or+by+property+address.\u0026amp;theme=85f832f8b30837d0268a5e67\u0026amp;signature=14479b33ef623cce35f43d588b746054da816765cc7bc723fe9cbb8e343b6f41\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/north/3ABOlXaiYgjBTlC1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"North Reports API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.northreports.com/api-reference/reports/get-report\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/reports/get-report.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.northreports.com/#organization\",\"name\":\"North Reports API\",\"url\":\"https://docs.northreports.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.northreports.com#website\",\"name\":\"North Reports API\",\"url\":\"https://docs.northreports.com\",\"publisher\":{\"@id\":\"https://docs.northreports.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.northreports.com/api-reference/reports/get-report#webpage\",\"url\":\"https://docs.northreports.com/api-reference/reports/get-report\",\"name\":\"Get Report\",\"description\":\"Retrieve a single North Report by ID or by property address.\",\"dateModified\":\"2026-03-06T20:05:01.163Z\",\"isPartOf\":{\"@id\":\"https://docs.northreports.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.northreports.com/api-reference/reports/get-report#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.northreports.com/api-reference/reports/get-report#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reports\",\"item\":\"https://docs.northreports.com/api-reference/reports/list-reports\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Report\",\"item\":\"https://docs.northreports.com/api-reference/reports/get-report\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.northreports.com/api-reference/reports/get-report#apireference\",\"headline\":\"Get Report\",\"name\":\"Get Report\",\"description\":\"Retrieve a single North Report by ID or by property address.\",\"url\":\"https://docs.northreports.com/api-reference/reports/get-report\",\"mainEntityOfPage\":{\"@id\":\"https://docs.northreports.com/api-reference/reports/get-report#webpage\"},\"dateModified\":\"2026-03-06T20:05:01.163Z\",\"publisher\":{\"@id\":\"https://docs.northreports.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.northreports.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"North Reports API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"North Reports API","nav":{"global":{"anchors":[{"anchor":"Dashboard","icon":"gauge","href":"https://northreports.com/dashboard"},{"anchor":"Support","icon":"envelope","href":"https://northreports.com/support"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Users","pages":[{"title":"Get Current User","openapi":"GET /v1/users/me","href":"/api-reference/users/get-current-user"}]},{"group":"Reports","pages":[{"title":"List Reports","openapi":"GET /v1/reports","href":"/api-reference/reports/list-reports"},{"title":"Create Report","openapi":"POST /v1/reports","description":"Creates a new North report with the provided property information.\nThe report will be created as a draft by default.\n","href":"/api-reference/reports/create-report"},{"title":"Get Report","openapi":"GET /v1/reports/{reportId}","href":"/api-reference/reports/get-report"},{"title":"Update Report","openapi":"PATCH /v1/reports/{reportId}","description":"Updates an existing report. Only provided fields will be updated.\n","href":"/api-reference/reports/update-report"},{"title":"Delete Report","openapi":"DELETE /v1/reports/{reportId}","href":"/api-reference/reports/delete-report"},{"title":"Publish Report","openapi":"POST /v1/reports/{reportId}/publish","href":"/api-reference/reports/publish-report"},{"title":"Unpublish Report","openapi":"POST /v1/reports/{reportId}/unpublish","href":"/api-reference/reports/unpublish-report"}]},{"group":"Comparables","pages":[{"title":"List Comparables","openapi":"GET /v1/comps","href":"/api-reference/comps/list-comps"},{"title":"Add Comparable","openapi":"POST /v1/comps","href":"/api-reference/comps/create-comp"},{"title":"Get Comparable","openapi":"GET /v1/comps/{compId}","href":"/api-reference/comps/get-comp"},{"title":"Update Comparable","openapi":"PATCH /v1/comps/{compId}","href":"/api-reference/comps/update-comp"},{"title":"Delete Comparable","openapi":"DELETE /v1/comps/{compId}","href":"/api-reference/comps/delete-comp"}]},{"group":"Showings","pages":[{"title":"List Showings","openapi":"GET /v1/showings","href":"/api-reference/showings/list-showings"},{"title":"Create Showing","openapi":"POST /v1/showings","href":"/api-reference/showings/create-showing"},{"title":"Get Showing","openapi":"GET /v1/showings/{showingId}","href":"/api-reference/showings/get-showing"},{"title":"Update Showing","openapi":"PATCH /v1/showings/{showingId}","href":"/api-reference/showings/update-showing"},{"title":"Delete Showing","openapi":"DELETE /v1/showings/{showingId}","href":"/api-reference/showings/delete-showing"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","openapi":"POST /v1/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook","openapi":"GET /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update Webhook","openapi":"PATCH /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","openapi":"DELETE /v1/webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"}]}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/zapier-integration"}]}]},"basePath":"","title":"Get Report - North Reports API","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}