The date-time in ISO 8601 format of archiving the tenancy
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Proper Docs","colors":{"primary":"#185333","light":"#5FD092","dark":"#185333"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/helloproper/XlPqfihjI91A1Qua/logo/proper-docs-light.svg?fit=max\u0026auto=format\u0026n=XlPqfihjI91A1Qua\u0026q=85\u0026s=e81320fb102f51d5c12e1b013e14baab","dark":"https://mintcdn.com/helloproper/XlPqfihjI91A1Qua/logo/proper-docs-dark.svg?fit=max\u0026auto=format\u0026n=XlPqfihjI91A1Qua\u0026q=85\u0026s=1dd6372c773dc0e1ae73db79122aa63d"},"api":{"mdx":{"server":"https://api.helloproper.com","auth":{"method":"key","name":"Authorization"}}},"background":{"decoration":null,"color":{"light":"#EFEFEF","dark":"#232323"}},"navbar":{"links":[{"label":"Support","href":"https://support.helloproper.com"}],"primary":{"type":"button","label":"Platform","href":"https://app.helloproper.com"}},"footer":{"socials":{"facebook":"https://www.facebook.com/ProperHQ","linkedin":"https://www.linkedin.com/company/properhq/"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helloproper","hasAudioNarration":false,"actualSubdomain":"helloproper","customDomains":["docs.helloproper.com"],"gitSource":{"type":"github","owner":"properhq","repo":"proper-api-reference","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c4133f39494aa9eef0b4","collectionId":"b3a147c0-fb6d-4bd6-a772-9305580093b7","schemaVersion":"v2"},"entitlements":{},"buildId":"6a20c4133f39494aa9eef0b4:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API reference","count":44},{"language":"default","tag":"Resources","count":32},{"language":"default","tag":"Leases","count":4},{"language":"default","tag":"Tenancies","count":4},{"language":"default","tag":"Contacts","count":3},{"language":"default","tag":"One time bill items","count":3},{"language":"default","tag":"Recurring bill items","count":3},{"language":"default","tag":"Documentation","count":3},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Bills","count":2}]},"assistantConfig":{},"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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/tenancies/list","slug":"/api-reference/tenancies/list","pageMetadata":{"title":"List tenancies","api":"GET /tenancies","description":null,"href":"/api-reference/tenancies/list"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Expandable,Heading,ResponseField}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`3`,id:`request`,children:`Request`}),`\n`,_jsx(_components.p,{children:`This request supports pagination.`}),`\n`,_jsx(Heading,{level:`3`,id:`response`,children:`Response`}),`\n`,_jsx(ResponseField,{name:`tenancies`,type:`array`,id:`param-tenancies`,children:_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id`,children:_jsx(_components.p,{children:`The unique identifier for the tenancy`})}),_jsxs(ResponseField,{name:`address`,type:`object`,id:`param-address`,children:[_jsx(_components.p,{children:`The address details of the tenancy`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`street`,type:`string`,id:`param-street`,children:_jsx(_components.p,{children:`The full street name and number`})}),_jsx(ResponseField,{name:`streetName`,type:`string`,id:`param-street-name`,children:_jsx(_components.p,{children:`The name of the street`})}),_jsx(ResponseField,{name:`streetNumber`,type:`string`,id:`param-street-number`,children:_jsx(_components.p,{children:`The number of the property on the street`})}),_jsx(ResponseField,{name:`floor`,type:`string`,id:`param-floor`,children:_jsx(_components.p,{children:`The floor of the address if applicable`})}),_jsx(ResponseField,{name:`door`,type:`string`,id:`param-door`,children:_jsx(_components.p,{children:`The door of the address if applicable`})}),_jsx(ResponseField,{name:`subdivision`,type:`string`,id:`param-subdivision`,children:_jsx(_components.p,{children:`The subdivision of the address if applicable`})}),_jsx(ResponseField,{name:`postalCode`,type:`string`,id:`param-postal-code`,children:_jsx(_components.p,{children:`The postal code for the address`})}),_jsx(ResponseField,{name:`city`,type:`string`,id:`param-city`,children:_jsx(_components.p,{children:`The city of the address`})}),_jsx(ResponseField,{name:`country`,type:`string`,id:`param-country`,children:_jsx(_components.p,{children:`The country code of the address`})})]})]}),_jsx(ResponseField,{name:`groupId`,type:`object`,id:`param-group-id`,children:_jsx(_components.p,{children:`Categories mapped to the corresponding groups`})}),_jsxs(ResponseField,{name:`currentLease`,type:`object`,id:`param-current-lease`,children:[_jsx(_components.p,{children:`The details of the Current Lease Object for the tenancy`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`id`,type:`string`,id:`param-id-1`,children:_jsx(_components.p,{children:`The unique identifier for the lease`})}),_jsx(ResponseField,{name:`tenancyId`,type:`string`,id:`param-tenancy-id`,children:_jsx(_components.p,{children:`The identifier for the tenancy associated with the lease`})}),_jsx(ResponseField,{name:`operationalState`,type:`string`,id:`param-operational-state`,children:_jsx(_components.p,{children:`The operational state of the lease (e.g., “Draft”)`})}),_jsx(ResponseField,{name:`contractPeriodState`,type:`string`,id:`param-contract-period-state`,children:_jsx(_components.p,{children:`The state of the contract period (e.g., “Active”)`})}),_jsx(ResponseField,{name:`primaryTenantContactName`,type:`string`,id:`param-primary-tenant-contact-name`,children:_jsx(_components.p,{children:`The name of the primary tenant contact`})}),_jsx(ResponseField,{name:`tenantIds`,type:`array`,id:`param-tenant-ids`,children:_jsx(_components.p,{children:`The identifiers for the tenants`})}),_jsx(ResponseField,{name:`associatedContactIds`,type:`array`,id:`param-associated-contact-ids`,children:_jsx(_components.p,{children:`The identifiers for the associated contacts`})}),_jsx(ResponseField,{name:`primaryTenantId`,type:`string`,id:`param-primary-tenant-id`,children:_jsx(_components.p,{children:`The identifier for the primary tenant`})}),_jsx(ResponseField,{name:`billingContactId`,type:`string`,id:`param-billing-contact-id`,children:_jsx(_components.p,{children:`The identifier for the billing contact`})}),_jsxs(ResponseField,{name:`balance`,type:`object`,id:`param-balance`,children:[_jsx(_components.p,{children:`The balance for the lease`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency`,children:_jsx(_components.p,{children:`The currency code for the balance amount (e.g., “DKK”)`})}),_jsx(ResponseField,{name:`amount`,type:`number`,id:`param-amount`,children:_jsx(_components.p,{children:`The amount of balance amount (e.g., 100.00)`})})]})]}),_jsxs(ResponseField,{name:`depositBalance`,type:`object`,id:`param-deposit-balance`,children:[_jsx(_components.p,{children:`The deposit balance for the lease`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-1`,children:_jsx(_components.p,{children:`The currency code for the deposit balance amount (e.g., “DKK”)`})}),_jsx(ResponseField,{name:`amount`,type:`number`,id:`param-amount-1`,children:_jsx(_components.p,{children:`The amount of the prepaid balance amount (e.g., 100.00)`})})]})]}),_jsxs(ResponseField,{name:`prepaidBalance`,type:`object`,id:`param-prepaid-balance`,children:[_jsx(_components.p,{children:`The prepaid balance for the lease`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-2`,children:_jsx(_components.p,{children:`The currency code for the balance amount (e.g., “DKK”)`})}),_jsx(ResponseField,{name:`amount`,type:`number`,id:`param-amount-2`,children:_jsx(_components.p,{children:`The amount of prepaid balance amount (e.g., 100.00)`})})]})]}),_jsx(ResponseField,{name:`contractStart`,type:`date`,id:`param-contract-start`,children:_jsx(_components.p,{children:`The start date of the contract in ISO 8601 format`})}),_jsx(ResponseField,{name:`contractEnd`,type:`date`,id:`param-contract-end`,children:_jsx(_components.p,{children:`The end date of the contract in ISO 8601 format`})}),_jsx(ResponseField,{name:`purpose`,type:`string`,id:`param-purpose`,children:_jsx(_components.p,{children:`The purpose of the lease (e.g., “key:residential”)`})}),_jsxs(ResponseField,{name:`monthlyRentLevel`,type:`object`,id:`param-monthly-rent-level`,children:[_jsx(_components.p,{children:`The monthly rent level details for the lease`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`currency`,type:`string`,id:`param-currency-3`,children:_jsx(_components.p,{children:`The currency code for the monthly rent level (e.g., “DKK”)`})}),_jsx(ResponseField,{name:`amount`,type:`number`,id:`param-amount-3`,children:_jsx(_components.p,{children:`The amount of the monthly rent level`})})]})]}),_jsx(ResponseField,{name:`archivedAt`,type:`date`,id:`param-archived-at`,children:_jsx(_components.p,{children:`The date-time in ISO 8601 format of archiving the lease`})})]})]}),_jsx(ResponseField,{name:`leaseIds`,type:`array`,id:`param-lease-ids`,children:_jsx(_components.p,{children:`The identifiers for all leases associated with the tenancy`})}),_jsx(ResponseField,{name:`unitType`,type:`string`,id:`param-unit-type`,children:_jsx(_components.p,{children:`The type of the unit (e.g., “PARKING”)`})}),_jsx(ResponseField,{name:`unitTypeName`,type:`string`,id:`param-unit-type-name`,children:_jsx(_components.p,{children:`The description of unit type, if unit type is “OTHER”`})}),_jsx(ResponseField,{name:`roomCounts`,type:`array`,id:`param-room-counts`,children:_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`type`,type:`string`,id:`param-type`,children:_jsx(_components.p,{children:`The type of the room (e.g., “ROOM”)`})}),_jsx(ResponseField,{name:`count`,type:`integer`,id:`param-count`,children:_jsx(_components.p,{children:`The count of the room type`})})]})}),_jsxs(ResponseField,{name:`totalArea`,type:`object`,id:`param-total-area`,children:[_jsx(_components.p,{children:`The total area of the tenancy`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`value`,type:`number`,id:`param-value`,children:_jsx(_components.p,{children:`The value of the total area`})}),_jsx(ResponseField,{name:`unit`,type:`string`,id:`param-unit`,children:_jsx(_components.p,{children:`The unit of measurement for the area (e.g., “m²”)`})})]})]}),_jsxs(ResponseField,{name:`businessArea`,type:`object`,id:`param-business-area`,children:[_jsx(_components.p,{children:`The business area of the tenancy`}),_jsxs(Expandable,{children:[_jsx(ResponseField,{name:`value`,type:`number`,id:`param-value-1`,children:_jsx(_components.p,{children:`The value of the business area`})}),_jsx(ResponseField,{name:`unit`,type:`string`,id:`param-unit-1`,children:_jsx(_components.p,{children:`The unit of measurement for the area (e.g., “m²”)`})})]})]}),_jsx(ResponseField,{name:`archivedAt`,type:`date`,id:`param-archived-at-1`,children:_jsx(_components.p,{children:`The date-time in ISO 8601 format of archiving the tenancy`})})]})})]})}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":"List tenancies","api":"GET /tenancies","description":null,"href":"/api-reference/tenancies/list"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Request","slug":"request","depth":3,"children":[]},{"title":"Response","slug":"response","depth":3,"children":[]}],"codeExamples":{},"endpoint":{"title":"List tenancies","path":"/tenancies","servers":[{"url":"https://api.helloproper.com"}],"method":"get","request":{"security":[{"title":"API Key Auth","parameters":{"header":{"Authorization":{"type":"apiKey"}},"query":{},"cookie":{}}}],"parameters":{"query":{},"header":{},"cookie":{},"path":{}},"body":{}},"response":{"200":{"application/json":{"schemaArray":[{"type":"object","properties":{"tenancies":[{"type":"array","items":[{"type":"object","properties":{"id":[{"type":"string","description":"The unique identifier for the tenancy"}],"address":[{"type":"object","properties":{"street":[{"type":"string","description":"The full street name and number"}],"streetName":[{"type":"string","description":"The name of the street"}],"streetNumber":[{"type":"string","description":"The number of the property on the street"}],"floor":[{"type":"string","description":"The floor of the address if applicable"}],"door":[{"type":"string","description":"The door of the address if applicable"}],"subdivision":[{"type":"string","description":"The subdivision of the address if applicable"}],"postalCode":[{"type":"string","description":"The postal code for the address"}],"city":[{"type":"string","description":"The city of the address"}],"country":[{"type":"string","description":"The country code of the address"}]},"description":"The address details of the tenancy"}],"groupId":[{"type":"object","properties":{},"description":"Categories mapped to the corresponding groups"}],"currentLease":[{"type":"object","properties":{"id":[{"type":"string","description":"The unique identifier for the lease"}],"tenancyId":[{"type":"string","description":"The identifier for the tenancy associated with the lease"}],"operationalState":[{"type":"string","description":"The operational state of the lease (e.g., “Draft”)"}],"contractPeriodState":[{"type":"string","description":"The state of the contract period (e.g., “Active”)"}],"primaryTenantContactName":[{"type":"string","description":"The name of the primary tenant contact"}],"tenantIds":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"The identifiers for the tenants"}],"associatedContactIds":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"The identifiers for the associated contacts"}],"primaryTenantId":[{"type":"string","description":"The identifier for the primary tenant"}],"billingContactId":[{"type":"string","description":"The identifier for the billing contact"}],"balance":[{"type":"object","properties":{"currency":[{"type":"string","description":"The currency code for the balance amount (e.g., “DKK”)"}],"amount":[{"type":"number","description":"The amount of balance amount (e.g., 100.00)"}]},"description":"The balance for the lease"}],"depositBalance":[{"type":"object","properties":{"currency":[{"type":"string","description":"The currency code for the deposit balance amount (e.g., “DKK”)"}],"amount":[{"type":"number","description":"The amount of the prepaid balance amount (e.g., 100.00)"}]},"description":"The deposit balance for the lease"}],"prepaidBalance":[{"type":"object","properties":{"currency":[{"type":"string","description":"The currency code for the balance amount (e.g., “DKK”)"}],"amount":[{"type":"number","description":"The amount of prepaid balance amount (e.g., 100.00)"}]},"description":"The prepaid balance for the lease"}],"contractStart":[{"type":"string","description":"The start date of the contract in ISO 8601 format"}],"contractEnd":[{"type":"string","description":"The end date of the contract in ISO 8601 format"}],"purpose":[{"type":"string","description":"The purpose of the lease (e.g., “key:residential”)"}],"monthlyRentLevel":[{"type":"object","properties":{"currency":[{"type":"string","description":"The currency code for the monthly rent level (e.g., “DKK”)"}],"amount":[{"type":"number","description":"The amount of the monthly rent level"}]},"description":"The monthly rent level details for the lease"}],"archivedAt":[{"type":"string","description":"The date-time in ISO 8601 format of archiving the lease"}]},"description":"The details of the Current Lease Object for the tenancy"}],"leaseIds":[{"type":"array","items":[{"type":"object","properties":{}}],"description":"The identifiers for all leases associated with the tenancy"}],"unitType":[{"type":"string","description":"The type of the unit (e.g., “PARKING”)"}],"unitTypeName":[{"type":"string","description":"The description of unit type, if unit type is “OTHER”"}],"roomCounts":[{"type":"array","items":[{"type":"object","properties":{"type":[{"type":"string","description":"The type of the room (e.g., “ROOM”)"}],"count":[{"type":"integer","description":"The count of the room type"}]}}]}],"totalArea":[{"type":"object","properties":{"value":[{"type":"number","description":"The value of the total area"}],"unit":[{"type":"string","description":"The unit of measurement for the area (e.g., “m²”)"}]},"description":"The total area of the tenancy"}],"businessArea":[{"type":"object","properties":{"value":[{"type":"number","description":"The value of the business area"}],"unit":[{"type":"string","description":"The unit of measurement for the area (e.g., “m²”)"}]},"description":"The business area of the tenancy"}],"archivedAt":[{"type":"string","description":"The date-time in ISO 8601 format of archiving the tenancy"}]}}]}]}}],"examples":{"example":{"value":{"tenancies":[{"id":"\u003cstring>","address":{"street":"\u003cstring>","streetName":"\u003cstring>","streetNumber":"\u003cstring>","floor":"\u003cstring>","door":"\u003cstring>","subdivision":"\u003cstring>","postalCode":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>"},"groupId":{},"currentLease":{"id":"\u003cstring>","tenancyId":"\u003cstring>","operationalState":"\u003cstring>","contractPeriodState":"\u003cstring>","primaryTenantContactName":"\u003cstring>","tenantIds":[{}],"associatedContactIds":[{}],"primaryTenantId":"\u003cstring>","billingContactId":"\u003cstring>","balance":{"currency":"\u003cstring>","amount":123},"depositBalance":{"currency":"\u003cstring>","amount":123},"prepaidBalance":{"currency":"\u003cstring>","amount":123},"contractStart":"\u003cstring>","contractEnd":"\u003cstring>","purpose":"\u003cstring>","monthlyRentLevel":{"currency":"\u003cstring>","amount":123},"archivedAt":"\u003cstring>"},"leaseIds":[{}],"unitType":"\u003cstring>","unitTypeName":"\u003cstring>","roomCounts":[{"type":"\u003cstring>","count":123}],"totalArea":{"value":123,"unit":"\u003cstring>"},"businessArea":{"value":123,"unit":"\u003cstring>"},"archivedAt":"\u003cstring>"}]}}}}}},"deprecated":false}},"jsLinks":[],"subdomain":"helloproper","siteName":"Proper Docs","title":"List tenancies - Proper Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-25T15:26:30.974Z","originalFileLocation":"api-reference/tenancies/list.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=\"Proper Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_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/helloproper/h6hNYaZ1OUbJl1c4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List tenancies - Proper Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Proper Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helloproper.com/api-reference/tenancies/list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://helloproper.mintlify.app/_mintlify/api/og/v2?division=Tenancies\u0026amp;title=List+tenancies\u0026amp;theme=15ceb0abc89ad8c80b5b6d38\u0026amp;signature=77237944302387a5dc57622d4d9d0a4fefaecbc53adb074cafe34bcbe780a42c\">\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=\"List tenancies - Proper Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://helloproper.mintlify.app/_mintlify/api/og/v2?division=Tenancies\u0026amp;title=List+tenancies\u0026amp;theme=15ceb0abc89ad8c80b5b6d38\u0026amp;signature=77237944302387a5dc57622d4d9d0a4fefaecbc53adb074cafe34bcbe780a42c\">\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/helloproper/h6hNYaZ1OUbJl1c4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Proper Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#185333\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helloproper.com/api-reference/tenancies/list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tenancies/list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helloproper.com/#organization\",\"name\":\"Proper Docs\",\"url\":\"https://docs.helloproper.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helloproper/XlPqfihjI91A1Qua/logo/proper-docs-light.svg?fit=max\u0026auto=format\u0026n=XlPqfihjI91A1Qua\u0026q=85\u0026s=e81320fb102f51d5c12e1b013e14baab\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helloproper.com#website\",\"name\":\"Proper Docs\",\"url\":\"https://docs.helloproper.com\",\"publisher\":{\"@id\":\"https://docs.helloproper.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helloproper.com/api-reference/tenancies/list#webpage\",\"url\":\"https://docs.helloproper.com/api-reference/tenancies/list\",\"name\":\"List tenancies\",\"dateModified\":\"2025-11-25T15:26:30.974Z\",\"isPartOf\":{\"@id\":\"https://docs.helloproper.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helloproper.com/api-reference/tenancies/list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helloproper.com/api-reference/tenancies/list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.helloproper.com/api-reference/tenancies/object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tenancies\",\"item\":\"https://docs.helloproper.com/api-reference/tenancies/object\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List tenancies\",\"item\":\"https://docs.helloproper.com/api-reference/tenancies/list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.helloproper.com/api-reference/tenancies/list#apireference\",\"headline\":\"List tenancies\",\"name\":\"List tenancies\",\"url\":\"https://docs.helloproper.com/api-reference/tenancies/list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helloproper.com/api-reference/tenancies/list#webpage\"},\"dateModified\":\"2025-11-25T15:26:30.974Z\",\"publisher\":{\"@id\":\"https://docs.helloproper.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helloproper.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Proper Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Proper Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Logs","href":"/api-reference/logs"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Versioning","href":"/api-reference/versioning"}]},{"group":"Resources","pages":[{"group":"Tenancies","pages":[{"title":"The tenancy object","description":null,"href":"/api-reference/tenancies/object"},{"title":"List tenancies","api":"GET /tenancies","href":"/api-reference/tenancies/list"},{"title":"Retrieve a tenancy","api":"GET /tenancies/{tenancyId}","description":null,"href":"/api-reference/tenancies/get"},{"title":"Creates a tenancy","api":"POST /tenancies","href":"/api-reference/tenancies/create"}]},{"group":"Leases","pages":[{"title":"The lease object","href":"/api-reference/leases/object"},{"title":"List leases","api":"GET /leases","href":"/api-reference/leases/list"},{"title":"Retrieve a lease","api":"GET /leases/{leaseId}","href":"/api-reference/leases/get"},{"title":"List lease transactions","api":"GET /leases/{leaseId}/transactions","href":"/api-reference/leases/list-transactions"}]},{"group":"Bills","pages":[{"title":"The bill object","href":"/api-reference/bills/object"},{"title":"List bills","api":"GET /bills","href":"/api-reference/bills/list"}]},{"group":"Pending bills","pages":[{"title":"The pending bill object","href":"/api-reference/pending-bills/object"},{"title":"List pending bills","api":"GET /pending-bills","href":"/api-reference/pending-bills/list"}]},{"group":"Payments","pages":[{"title":"The payment object","href":"/api-reference/payments/object"},{"title":"List payments","api":"GET /payments","href":"/api-reference/payments/list"}]},{"group":"Payouts","pages":[{"title":"The payout object","href":"/api-reference/payouts/object"},{"title":"List payouts","api":"GET /payouts","href":"/api-reference/payouts/list"}]},{"group":"Recurring bill items","pages":[{"title":"The recurring bill item object","href":"/api-reference/recurring-bill-items/object"},{"title":"List recurring bill items","api":"GET /recurring-bill-items","href":"/api-reference/recurring-bill-items/list"},{"title":"Create recurring bill item","api":"POST /recurring-bill-items","href":"/api-reference/recurring-bill-items/create"}]},{"group":"One time bill items","pages":[{"title":"The one-time bill item object","href":"/api-reference/one-time-bill-items/object"},{"title":"List one-time bill items","api":"GET /one-time-bill-items","href":"/api-reference/one-time-bill-items/list"},{"title":"Create one-time bill item","api":"POST /one-time-bill-items","href":"/api-reference/one-time-bill-items/create"}]},{"group":"Transactions","pages":[{"title":"The transaction object","href":"/api-reference/transactions/object"}]},{"group":"Products","pages":[{"title":"The products object","href":"/api-reference/products/object"},{"title":"List products","api":"GET /products","href":"/api-reference/products/list"}]},{"group":"Contacts","pages":[{"title":"The contact object","href":"/api-reference/contacts/object"},{"title":"List contacts","api":"GET /contacts","href":"/api-reference/contacts/list"},{"title":"Retrieve a contact","api":"GET /contacts/{contactId}","href":"/api-reference/contacts/get"}]},{"group":"Rent adjustment","pages":[{"title":"The rent adjustment plan object","href":"/api-reference/rent-adjustment/object"},{"title":"List rent adjustments","api":"GET /rent-adjustment-plans","href":"/api-reference/rent-adjustment/list"}]},{"group":"Categories","pages":[{"title":"The category object","href":"/api-reference/categories/object"},{"title":"List categories","api":"GET /categories","href":"/api-reference/categories/list"}]}]}]}]},"basePath":"","title":"List tenancies - Proper Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js"]}