The legal contract between a property manager and the tenant. A lease agreement contains information about the property, the address and duration of the lease, and financial terms like rent amount and security deposit information. Leases map 1:1 with TheGuarantors surety bonds. A single lease can have one or more applicants.
Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.
The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.
{
"message": "application not found",
"object": "error"
}
{
"message": "internal server error",
"object": "error"
}
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"The Guarantors API","description":"Developer documentation for TheGuarantors Embed API: invites, applications, bonds, webhooks and the sandbox.","colors":{"primary":"#3DB157","light":"#3DB157","dark":"#3DB157"},"logo":{"light":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7","dark":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=7bc091265f808f82f21f214c0ea22d2f"},"favicon":"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/favicon.png?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=73fef4218af15ee58b6e5ad76682046c","footer":{"socials":{"linkedin":"https://www.linkedin.com/company/the-guarantors","x":"https://twitter.com/The_Guarantors","facebook":"https://www.facebook.com/TheGuarantors","instagram":"https://www.instagram.com/theguarantors"},"links":[{"header":" ","items":[{"label":"Privacy Policy","href":"https://www.theguarantors.com/privacy"},{"label":"Terms of Service","href":"https://www.theguarantors.com/terms"},{"label":"Legal / Regulatory Notice","href":"https://www.theguarantors.com/legal-regulatory"}]},{"header":" ","items":[{"label":"Notice of Collection","href":"https://www.theguarantors.com/notice-of-collection"},{"label":"Trust Center","href":"https://trust.theguarantors.com"}]}]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"theguarantors-2e3c1083","hasAudioNarration":false,"actualSubdomain":"theguarantors-2e3c1083","customDomains":["docs.theguarantors.com"],"gitSource":{"type":"github","owner":"theguarantors","repo":"tg-edge-service","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af20a0d60eda55d1f7e6246","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Application API","count":30},{"language":"default","tag":"Docs","count":12},{"language":"default","tag":"Schemas","count":10},{"language":"default","tag":"Applications","count":9},{"language":"default","tag":"Invites","count":7},{"language":"default","tag":"Core Concepts","count":6},{"language":"default","tag":"Invite Recipients","count":6},{"language":"default","tag":"Bonds","count":4},{"language":"default","tag":"Applicants","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"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":"editor-metadata","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},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#content-area table td:first-child code{white-space:nowrap;overflow-wrap:normal}"}],"page":{"pagePath":"application-api/applications/retrieve-an-application-by-invite","slug":"/application-api/applications/retrieve-an-application-by-invite","pageMetadata":{"title":"Retrieve an application by invite","description":null,"deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{invite_id}/application","href":"/application-api/applications/retrieve-an-application-by-invite","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve an application by invite","description":null,"deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{invite_id}/application","href":"/application-api/applications/retrieve-an-application-by-invite","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["749deec7-beb4-4c11-9679-1cf65ac65d3b"],"tags":["Applications"],"summary":"Retrieve an application by invite","parameters":["97490f86-0601-47a1-9bd5-f8c70c9ab0a8"],"responses":{"200":"8532030c-7e60-4f86-908d-71b068184eac","401":"8c701512-909d-4cb8-a600-f81e3835779a","404":"d2560216-4912-4a9e-a91e-ed52ef08a35d","429":"a9475c44-d62d-4e37-b91b-aa67f6302dd4","500":"e413f4b8-74b4-45e1-97f1-4ec772d995c1"},"method":"get","type":"path","servers":["4c923e28-1932-4d68-820c-f5aa1183a0de"],"path":"/v1/invites/{invite_id}/application","baseUrlOptions":["https://api.theguarantors.com"],"title":"Retrieve an application by invite","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"97490f86-0601-47a1-9bd5-f8c70c9ab0a8":{"description":"Invite ID","name":"invite_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Invite ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"8532030c-7e60-4f86-908d-71b068184eac":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["applicants","id","invite_id","lease","object","property_id","status"],"properties":{"applicants":{"description":"List of Applicant entities (representing one or more tenants) that are applying for coverage.","type":"array","items":{"type":"object","required":["email","first_name","id","last_name","object","status"],"properties":{"email":{"type":"string","example":"dana.whitfield@example.com","isRequired":true,"uniqueKey":"applicants.items.[INDEX].email","typeLabel":"string"},"first_name":{"type":"string","example":"Dana","isRequired":true,"uniqueKey":"applicants.items.[INDEX].first_name","typeLabel":"string"},"id":{"description":"Unique identifier.","type":"string","example":"applc_01HQ9A","isRequired":true,"uniqueKey":"applicants.items.[INDEX].id","typeLabel":"string"},"last_name":{"type":"string","example":"Whitfield","isRequired":true,"uniqueKey":"applicants.items.[INDEX].last_name","typeLabel":"string"},"object":{"type":"string","example":"applicant","isRequired":true,"uniqueKey":"applicants.items.[INDEX].object","typeLabel":"string"},"status":{"type":"string","description":"Enum representing the applicant's current state in the application process.","enum":["not_started","started","submitted"],"x-enum-varnames":["APPLICANT_NOT_STARTED","APPLICANT_STARTED","APPLICANT_SUBMITTED"],"example":"submitted","isRequired":true,"uniqueKey":"applicants.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"metadata":{"oneOf":[{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"object","uniqueKey":"applicants.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"null","uniqueKey":"applicants.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"applicants.items.[INDEX].metadata","typeLabel":"object | null"},"phone_number":{"oneOf":[{"description":"E.164 formatted phone number","type":"string","example":"+15551234567","uniqueKey":"applicants.items.[INDEX].phone_number.oneOf.0","typeLabel":"string"},{"description":"E.164 formatted phone number","type":"null","example":"+15551234567","uniqueKey":"applicants.items.[INDEX].phone_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"applicants.items.[INDEX].phone_number","typeLabel":"string | null"}},"uniqueKey":"applicants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"applicants","typeLabel":"object[]"},"id":{"description":"Unique identifier.","type":"string","example":"sd_01HQ8Z","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"invite_id":{"type":"string","example":"inv_01HQ8X","isRequired":true,"uniqueKey":"invite_id","typeLabel":"string"},"lease":{"type":"object","description":"The legal contract between a property manager and the tenant. A lease agreement contains information about the property, the address and duration of the lease, and financial terms like rent amount and security deposit information. Leases map 1:1 with TheGuarantors surety bonds. A single lease can have one or more applicants.","required":["monthly_rent","object","unit_address"],"properties":{"monthly_rent":{"description":"Monthly rent in cents.","type":"integer","minimum":1,"example":280000,"isRequired":true,"uniqueKey":"lease.monthly_rent","typeLabel":"integer"},"object":{"type":"string","example":"lease","isRequired":true,"uniqueKey":"lease.object","typeLabel":"string"},"unit_address":{"type":"object","description":"The unit address that would be printed on the lease, and therefore the Lease Guarantee surety bond. If you do not store the address with separate address line 1s and address line 2, put the full unit address in the address line 1.","required":["city","line1","object","postal_code","state"],"properties":{"city":{"description":"City which this address is located in","type":"string","example":"Brooklyn","isRequired":true,"uniqueKey":"lease.unit_address.city","typeLabel":"string"},"line1":{"description":"Address line 1","type":"string","example":"412 Halsey St","isRequired":true,"uniqueKey":"lease.unit_address.line1","typeLabel":"string"},"object":{"type":"string","example":"address","isRequired":true,"uniqueKey":"lease.unit_address.object","typeLabel":"string"},"postal_code":{"description":"Postal or Zip code for this address","type":"string","example":"11233","isRequired":true,"uniqueKey":"lease.unit_address.postal_code","typeLabel":"string"},"state":{"description":"State which this address is located in","type":"string","example":"NY","isRequired":true,"uniqueKey":"lease.unit_address.state","typeLabel":"string"},"line2":{"oneOf":[{"description":"Address line 2","type":"string","example":"Apt 3R","uniqueKey":"lease.unit_address.line2.oneOf.0","typeLabel":"string"},{"description":"Address line 2","type":"null","example":"Apt 3R","uniqueKey":"lease.unit_address.line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.unit_address.line2","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"lease.unit_address","typeLabel":"object"},"end_date":{"oneOf":[{"description":"The date when this lease expires.","type":"string","format":"date","example":"2027-08-31","uniqueKey":"lease.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease expires.","type":"null","format":"date","example":"2027-08-31","uniqueKey":"lease.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.end_date","typeLabel":"string\u003cdate> | null"},"start_date":{"oneOf":[{"description":"The date when this lease takes effect.","type":"string","format":"date","example":"2026-09-01","uniqueKey":"lease.start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"The date when this lease takes effect.","type":"null","format":"date","example":"2026-09-01","uniqueKey":"lease.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"lease.start_date","typeLabel":"string\u003cdate> | null"}},"isRequired":true,"uniqueKey":"lease","typeLabel":"object"},"object":{"type":"string","example":"application","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"property_id":{"type":"string","example":"prop_01HQ7A","isRequired":true,"uniqueKey":"property_id","typeLabel":"string"},"status":{"type":"string","description":"Enum representing the current state in the application process.","enum":["started","approved","denied","canceled","bound","submitted","pending"],"x-enum-varnames":["APPLICATION_STARTED","APPLICATION_APPROVED","APPLICATION_DENIED","APPLICATION_CANCELED","APPLICATION_BOUND","APPLICATION_SUBMITTED","APPLICATION_PENDING"],"example":"approved","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"bond_id":{"oneOf":[{"type":"string","example":"bond_01HQAB","uniqueKey":"bond_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"bond_01HQAB","uniqueKey":"bond_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"bond_id","typeLabel":"string | null"},"metadata":{"oneOf":[{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"object","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"description":"Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.","type":"null","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"obligee":{"oneOf":[{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"string","example":"Rivermark Residential LLC","uniqueKey":"obligee.oneOf.0","typeLabel":"string"},{"description":"The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.","type":"null","example":"Rivermark Residential LLC","uniqueKey":"obligee.oneOf.1","typeLabel":"null"}],"uniqueKey":"obligee","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"sd_3k29dls92jf83kdl","status":"bound","obligee":"Acme Property Management LLC","invite_id":"inv_8f3k2jd9slq02mxp","property_id":"prop_nvlbcx2e5jk0fqsf","bond_id":"bond_7f29djw82kdpq9sl","lease":{"start_date":"2026-03-01","end_date":"2027-02-28","monthly_rent":320000,"unit_address":{"line1":"123 Main St","line2":"Apt 5B","city":"New York","state":"NY","postal_code":"10001","object":"address"},"object":"lease"},"applicants":[{"id":"applc_e91hmctvoraymdpu","status":"submitted","first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","metadata":{},"object":"applicant"},{"id":"applc_dc6jvyyvb8yw843q","status":"submitted","first_name":"John","last_name":"Smith","email":"john.smith@example.com","phone_number":"+13475559876","metadata":{},"object":"applicant"}],"metadata":{},"object":"application"},"examples":{"Example":{"title":"Example","value":{"id":"sd_3k29dls92jf83kdl","status":"bound","obligee":"Acme Property Management LLC","invite_id":"inv_8f3k2jd9slq02mxp","property_id":"prop_nvlbcx2e5jk0fqsf","bond_id":"bond_7f29djw82kdpq9sl","lease":{"start_date":"2026-03-01","end_date":"2027-02-28","monthly_rent":320000,"unit_address":{"line1":"123 Main St","line2":"Apt 5B","city":"New York","state":"NY","postal_code":"10001","object":"address"},"object":"lease"},"applicants":[{"id":"applc_e91hmctvoraymdpu","status":"submitted","first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","phone_number":"+12125551234","metadata":{},"object":"applicant"},{"id":"applc_dc6jvyyvb8yw843q","status":"submitted","first_name":"John","last_name":"Smith","email":"john.smith@example.com","phone_number":"+13475559876","metadata":{},"object":"applicant"}],"metadata":{},"object":"application"}}},"exampleType":"examples"}},"exampleType":"examples"},"8c701512-909d-4cb8-a600-f81e3835779a":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["message","object"],"properties":{"message":{"type":"string","example":"invite not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Missing authorization header","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"Missing authorization header","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"d2560216-4912-4a9e-a91e-ed52ef08a35d":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["message","object"],"properties":{"message":{"type":"string","example":"invite not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"application not found","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"application not found","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"},"a9475c44-d62d-4e37-b91b-aa67f6302dd4":{"description":"Rate limit exceeded","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"e413f4b8-74b4-45e1-97f1-4ec772d995c1":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["message","object"],"properties":{"message":{"type":"string","example":"invite not found","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"internal server error","object":"error"},"examples":{"Example":{"title":"Example","value":{"message":"internal server error","object":"error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"749deec7-beb4-4c11-9679-1cf65ac65d3b":{"BasicAuth":{"type":"http","scheme":"basic","scopes":[],"schemeName":"BasicAuth"}}},"servers":{"4c923e28-1932-4d68-820c-f5aa1183a0de":{"url":"https://api.theguarantors.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/application-api.json"},"subdomain":"theguarantors-2e3c1083","siteName":"The Guarantors API","title":"Retrieve an application by invite - The Guarantors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T17:59:59.495Z","originalFileLocation":"application-api/applications/retrieve-an-application-by-invite.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=\"application-name\" content=\"The Guarantors 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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve an application by invite - The Guarantors API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"The Guarantors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Applications\u0026amp;title=Retrieve+an+application+by+invite\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=140f2f2bc56b5e8459840d99b40d1e7c926cdadf2d633d0441e798f2631b3255\">\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=\"Retrieve an application by invite - The Guarantors API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://theguarantors-2e3c1083.mintlify.site/_mintlify/api/og/v2?division=Applications\u0026amp;title=Retrieve+an+application+by+invite\u0026amp;theme=24319ea74a156df9f19e7c2d\u0026amp;signature=140f2f2bc56b5e8459840d99b40d1e7c926cdadf2d633d0441e798f2631b3255\">\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/theguarantors-2e3c1083/tSXTvjNgqk32WtbT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"The Guarantors API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3DB157\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/application-api/applications/retrieve-an-application-by-invite.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.theguarantors.com/#organization\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/theguarantors-2e3c1083/1COSbAUD3YqBCY97/images/logo/light.svg?fit=max\u0026auto=format\u0026n=1COSbAUD3YqBCY97\u0026q=85\u0026s=90090207d22f93a49206278f09bbbff7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.theguarantors.com#website\",\"name\":\"The Guarantors API\",\"url\":\"https://docs.theguarantors.com\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite#webpage\",\"url\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite\",\"name\":\"Retrieve an application by invite\",\"dateModified\":\"2026-11-09T17:59:59.495Z\",\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Application API\",\"item\":\"https://docs.theguarantors.com/application-api/invites/create-an-invite\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Applications\",\"item\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve an application by invite\",\"item\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite#apireference\",\"headline\":\"Retrieve an application by invite\",\"name\":\"Retrieve an application by invite\",\"url\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite\",\"mainEntityOfPage\":{\"@id\":\"https://docs.theguarantors.com/application-api/applications/retrieve-an-application-by-invite#webpage\"},\"dateModified\":\"2026-11-09T17:59:59.495Z\",\"publisher\":{\"@id\":\"https://docs.theguarantors.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.theguarantors.com#website\"}}]}\u003c/script>","siteName":"The Guarantors API","nav":{"global":null,"tabs":[{"tab":"Docs","pages":[{"title":"Docs","href":"/quickstart"}]},{"tab":"API Reference","groups":[{"group":"Application API","pages":[{"group":"Invites","pages":[{"title":"Create an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites","href":"/application-api/invites/create-an-invite"},{"title":"Retrieve an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{id}","href":"/application-api/invites/retrieve-an-invite"},{"title":"List invites","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites","href":"/application-api/invites/list-invites"},{"title":"Update an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invites/{id}","href":"/application-api/invites/update-an-invite"},{"title":"Cancel an invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/cancel","href":"/application-api/invites/cancel-an-invite"},{"title":"invite.updated","version":null,"deprecated":null,"sidebarTitle":"invite.updated","openapi":"/openapi/application-api.json webhook invite.updated","href":"/application-api/invites/inviteupdated"},{"title":"invite.status.canceled","version":null,"deprecated":null,"sidebarTitle":"invite.status.canceled","openapi":"/openapi/application-api.json webhook invite.status.canceled","href":"/application-api/invites/invitestatuscanceled"}]},{"group":"Invite Recipients","pages":[{"title":"Add an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/invites/{id}/invite-recipients","href":"/application-api/invites/add-an-invite-recipient"},{"title":"Update an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json patch /v1/invite-recipients/{id}","href":"/application-api/invites/update-an-invite-recipient"},{"title":"Remove an invite recipient","deprecated":null,"version":null,"openapi":"/openapi/application-api.json delete /v1/invite-recipients/{id}","href":"/application-api/invites/remove-an-invite-recipient"},{"title":"invite_recipient.added","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.added","openapi":"/openapi/application-api.json webhook invite_recipient.added","href":"/application-api/invites/invite_recipientadded"},{"title":"invite_recipient.updated","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.updated","openapi":"/openapi/application-api.json webhook invite_recipient.updated","href":"/application-api/invites/invite_recipientupdated"},{"title":"invite_recipient.removed","version":null,"deprecated":null,"sidebarTitle":"invite_recipient.removed","openapi":"/openapi/application-api.json webhook invite_recipient.removed","href":"/application-api/invites/invite_recipientremoved"}]},{"group":"Applications","pages":[{"title":"Retrieve an application","description":null,"deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{id}","href":"/application-api/applications/retrieve-an-application"},{"title":"Retrieve an application by invite","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/invites/{invite_id}/application","href":"/application-api/applications/retrieve-an-application-by-invite"},{"title":"Cancel an application","description":"Cancels an application that has not yet been bound and sends an `application.status.canceled` webhook. Returns 409 once a bond has been issued. Canceling an application that is already canceled returns 200 with the application unchanged.","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/applications/{id}/cancel","href":"/application-api/applications/cancel-an-application"},{"title":"application.status.started","version":null,"deprecated":null,"sidebarTitle":"application.status.started","openapi":"/openapi/application-api.json webhook application.status.started","href":"/application-api/applications/applicationstatusstarted"},{"title":"application.status.submitted","version":null,"deprecated":null,"sidebarTitle":"application.status.submitted","openapi":"/openapi/application-api.json webhook application.status.submitted","href":"/application-api/applications/applicationstatussubmitted"},{"title":"application.status.pending","version":null,"deprecated":null,"sidebarTitle":"application.status.pending","openapi":"/openapi/application-api.json webhook application.status.pending","href":"/application-api/applications/applicationstatuspending"},{"title":"application.status.approved","version":null,"deprecated":null,"sidebarTitle":"application.status.approved","openapi":"/openapi/application-api.json webhook application.status.approved","href":"/application-api/applications/applicationstatusapproved"},{"title":"application.status.denied","version":null,"deprecated":null,"sidebarTitle":"application.status.denied","openapi":"/openapi/application-api.json webhook application.status.denied","href":"/application-api/applications/applicationstatusdenied"},{"title":"application.status.canceled","version":null,"deprecated":null,"sidebarTitle":"application.status.canceled","openapi":"/openapi/application-api.json webhook application.status.canceled","href":"/application-api/applications/applicationstatuscanceled"}]},{"group":"Applicants","pages":[{"title":"Retrieve an applicant","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applicants/{id}","href":"/application-api/applicants/retrieve-an-applicant"},{"title":"applicant.status.started","version":null,"deprecated":null,"sidebarTitle":"applicant.status.started","openapi":"/openapi/application-api.json webhook applicant.status.started","href":"/application-api/applicants/applicantstatusstarted"},{"title":"applicant.status.submitted","version":null,"deprecated":null,"sidebarTitle":"applicant.status.submitted","openapi":"/openapi/application-api.json webhook applicant.status.submitted","href":"/application-api/applicants/applicantstatussubmitted"}]},{"group":"Bonds","pages":[{"title":"Retrieve a bond","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/bonds/{id}","href":"/application-api/bonds/retrieve-a-bond"},{"title":"List bonds for an application","deprecated":null,"version":null,"openapi":"/openapi/application-api.json get /v1/applications/{application_id}/bonds","href":"/application-api/bonds/list-bonds-for-an-application"},{"title":"bond.status.issued","version":null,"deprecated":null,"sidebarTitle":"bond.status.issued","openapi":"/openapi/application-api.json webhook bond.status.issued","href":"/application-api/bonds/bondstatusissued"},{"title":"bond.status.canceled","version":null,"deprecated":null,"sidebarTitle":"bond.status.canceled","openapi":"/openapi/application-api.json webhook bond.status.canceled","href":"/application-api/bonds/bondstatuscanceled"}]},{"group":"Webhooks","pages":[{"title":"Trigger a sandbox webhook","deprecated":null,"version":null,"openapi":"/openapi/application-api.json post /v1/webhooks/trigger","href":"/application-api/webhooks/trigger-a-sandbox-webhook"}]}]},{"group":"Schemas","pages":[{"title":"Invite","href":"/schemas/invite"},{"title":"InviteRecipient","href":"/schemas/invite-recipient"},{"title":"Lease","href":"/schemas/lease"},{"title":"Address","href":"/schemas/address"},{"title":"Coverage","href":"/schemas/coverage"},{"title":"Application","href":"/schemas/application"},{"title":"Applicant","href":"/schemas/applicant"},{"title":"Bond","href":"/schemas/bond"},{"title":"Principal","href":"/schemas/principal"},{"title":"Error","href":"/schemas/error"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Retrieve an application by invite - The Guarantors API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-C945cI-W.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}