{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Smokeball","colors":{"primary":"#f2600c","light":"#f2600c","dark":"#f2600c"},"logo":{"light":"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/light.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=9742e65825b3575ca562541e0e7571d3","dark":"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/dark.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=41d28476531680072164e1c91ac71a92","href":"https://www.smokeball.com"},"favicon":"https://mintcdn.com/smokeball/LxpjiDzzIUXckVg2/favicon.png?fit=max\u0026auto=format\u0026n=LxpjiDzzIUXckVg2\u0026q=85\u0026s=7230aa1ad4ca565e84539a7635af36e2","appearance":{"default":"light"},"navbar":{"links":[{"href":"https://support.smokeball.com","label":"Support"}],"primary":{"type":"button","label":"Developer Console","href":"https://console.smokeball.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/smokeball-com","facebook":"https://www.facebook.com/SmokeballUS","youtube":"https://www.youtube.com/c/SmokeballNews"}},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Inter"}},"styling":{"codeblocks":"dark","latex":false},"navigation":{"global":{"anchors":[{"anchor":"Marketplace","icon":"store","href":"https://marketplace.smokeball.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.smokeball.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smokeball","hasAudioNarration":false,"actualSubdomain":"smokeball","customDomains":["docs.smokeball.com"],"gitSource":{"type":"github","owner":"smokeballdev","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adaabf83e07a5d1950139ca","collectionId":"07591362-f6c3-4c9c-9a72-1853f16a5d9a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adaabf83e07a5d1950139ca"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adaabf83e07a5d1950139ca","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API","count":212},{"language":"default","tag":"APIs","count":195},{"language":"default","tag":"SDK","count":40},{"language":"default","tag":"Documentation","count":15},{"language":"default","tag":"Matters","count":15},{"language":"default","tag":"Contacts","count":14},{"language":"default","tag":"Tasks","count":14},{"language":"default","tag":"Files","count":13},{"language":"default","tag":"Platform","count":11},{"language":"default","tag":"Bank Accounts","count":10}]},"assistantConfig":{},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"billing-updated-9-15","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":"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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#hero-container{height:24rem;overflow:hidden}#hero-background{opacity:.05}#hero-content{position:absolute;text-align:center;padding:0 1rem}#hero-title{font-weight:800;font-size:36px;margin:0;font-family:Poppins}#hero-description{font-weight:400;font-size:16px;max-width:42rem;text-align:center;margin:1rem auto;font-family:Poppins}#home-search-entry{margin-top:2rem;max-width:24rem;font-family:Poppins;font-weight:700;font-size:1.1rem;letter-spacing:.02em;border:2px solid transparent;cursor:pointer;transition:all .2s ease-in-out;outline:0;background-color:#ff5c00;box-shadow:0 4px 6px -1px rgba(0,0,0,.1),0 2px 4px -1px rgba(0,0,0,.06)}#home-search-entry:hover{background-color:#ff7a33;transform:scale(1.02);box-shadow:0 6px 8px -1px rgba(0,0,0,.15),0 3px 6px -1px rgba(0,0,0,.08)}#search-icon{margin-right:.75rem;mask-image:url(https://mintlify.b-cdn.net/v6.5.1/solid/magnifying-glass.svg);mask-repeat:no-repeat;mask-position:center center;background-color:currentColor}#main-content-container{margin-top:2rem;margin-bottom:8rem;max-width:70rem;margin-left:auto;margin-right:auto;padding-left:1.25rem;padding-right:1.25rem}#documentation-section{margin-top:2rem;margin-bottom:2rem}#documentation-title{font-size:2rem;font-weight:800;font-family:Poppins}#partner-section{margin-top:2rem;margin-bottom:2rem}#partner-title{font-size:2rem;font-weight:800;font-family:Poppins}#partner-description{font-size:1.05rem;margin-bottom:1rem}"}],"page":{"pagePath":"api-reference/firm/get-firm","slug":"/api-reference/firm/get-firm","pageMetadata":{"title":"Get firm","description":"Retrieves the details of the firm associated with the authenticated client.","deprecated":null,"version":null,"openapi":"/openapi.json get /firm","href":"/api-reference/firm/get-firm","autogeneratedByOpenApi":true},"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: \"Retrieves the details of the firm associated with the authenticated client.\"\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{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":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get firm","description":"Retrieves the details of the firm associated with the authenticated client.","deprecated":null,"version":null,"openapi":"/openapi.json get /firm","href":"/api-reference/firm/get-firm","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/smokeball/5af3984d21ddfa7a/scripts/lib/claude-client.js","/_mintlify/custom/smokeball/4484f15c23b65054/scripts/lib/jira-client.js","/_mintlify/custom/smokeball/5079fd8276126440/scripts/lib/mdx-parser.js","/_mintlify/custom/smokeball/d3836391da5f0f6d/scripts/lib/summary-formatter.js","/_mintlify/custom/smokeball/b2629937faf7b0d7/scripts/update-release-notes.js"],"openApiReferenceData":{"operation":{"tags":["Firm"],"summary":"Get firm","description":"Retrieves the details of the firm associated with the authenticated client.","operationId":"GetFirm","responses":{"200":"673c3b00-5a4d-482f-9c14-31802c989579","404":"5705be44-ecfe-43e9-a90e-38ea20af6aa5"},"method":"get","type":"path","servers":["1115e230-afa6-43e1-bcf2-af1e747375f0","1785f238-40d5-4015-a51e-d87561a47c2f","28d84b45-11d8-4f57-92d2-88a3fe6659f3","9bb3f04e-98f2-4154-9375-d6eccd072fdf","6b2c171b-1851-4b52-89e9-8af4bc0f93d0","45158a02-bc8f-4d48-b521-bd140b06aa83"],"security":["ed4ed28c-ced2-4e57-934b-63036aa00efc"],"path":"/firm","baseUrlOptions":["https://api.smokeball.com","https://api.smokeball.com.au","https://api.smokeball.co.uk","https://stagingapi.smokeball.com","https://stagingapi.smokeball.com.au","https://stagingapi.smokeball.co.uk"],"title":"Get firm","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"673c3b00-5a4d-482f-9c14-31802c989579":{"description":"When request is successful. Returns a 'Firm' object.","content":{"application/json":{"schema":{"type":"object","properties":{"href":{"oneOf":[{"type":"string","uniqueKey":"href.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"href.oneOf.1","typeLabel":"null"}],"uniqueKey":"href","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","uniqueKey":"relation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"relation","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","default":"GET","uniqueKey":"method.oneOf.0","typeLabel":"string"},{"type":"null","default":"GET","uniqueKey":"method.oneOf.1","typeLabel":"null"}],"uniqueKey":"method","typeLabel":"string | null"},"self":{"oneOf":[{"type":"object","properties":{"id":{"oneOf":[{"type":"string","uniqueKey":"self.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"self.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"self.oneOf.0.id","typeLabel":"string | null"},"href":{"oneOf":[{"type":"string","uniqueKey":"self.oneOf.0.href.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"self.oneOf.0.href.oneOf.1","typeLabel":"null"}],"uniqueKey":"self.oneOf.0.href","typeLabel":"string | null"},"relation":{"oneOf":[{"type":"string","uniqueKey":"self.oneOf.0.relation.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"self.oneOf.0.relation.oneOf.1","typeLabel":"null"}],"uniqueKey":"self.oneOf.0.relation","typeLabel":"string | null"},"method":{"oneOf":[{"type":"string","default":"GET","uniqueKey":"self.oneOf.0.method.oneOf.0","typeLabel":"string"},{"type":"null","default":"GET","uniqueKey":"self.oneOf.0.method.oneOf.1","typeLabel":"null"}],"uniqueKey":"self.oneOf.0.method","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"self.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"self.oneOf.1","typeLabel":"null"}],"uniqueKey":"self","typeLabel":"object | null"},"id":{"oneOf":[{"type":"string","description":"Unique identifier of the firm.","example":"f4ff1eff-b7fe-4d46-4e46-01d985838d76","uniqueKey":"id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique identifier of the firm.","example":"f4ff1eff-b7fe-4d46-4e46-01d985838d76","uniqueKey":"id.oneOf.1","typeLabel":"null"}],"uniqueKey":"id","typeLabel":"string | null"},"versionId":{"oneOf":[{"type":"string","description":"Version id of the record.","example":"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8","uniqueKey":"versionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Version id of the record.","example":"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8","uniqueKey":"versionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"versionId","typeLabel":"string | null"},"owner":{"oneOf":[{"type":"string","description":"The owner/white-label partner used by the firm.\r\n\r\nPossible values: Smokeball, PracticeEvolve, TriConvey.","example":"Smokeball","uniqueKey":"owner.oneOf.0","typeLabel":"string"},{"type":"null","description":"The owner/white-label partner used by the firm.\r\n\r\nPossible values: Smokeball, PracticeEvolve, TriConvey.","example":"Smokeball","uniqueKey":"owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"The name of the firm.","example":"Brown LLC","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the firm.","example":"Brown LLC","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"status":{"oneOf":[{"type":"object","description":"The status of the firm.","properties":{"status":{"type":"string","description":"The status of the firm.","enum":["Active","Warning","Suspended"],"example":"Active","uniqueKey":"status.oneOf.0.status","typeLabel":"enum\u003cstring>"},"statusMessage":{"oneOf":[{"type":"string","description":"The status message of the firm.","uniqueKey":"status.oneOf.0.statusMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"The status message of the firm.","uniqueKey":"status.oneOf.0.statusMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"status.oneOf.0.statusMessage","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"status.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"object | null"},"productId":{"oneOf":[{"type":"string","description":"The product/tier the firm is subscribed to. Must be set when creating the firm and is optional when updating the firm.\r\n\r\nThe supported products are listed in order below, the identifier (in brackets) must be used.\r\n\r\n* Bill (SMK001)\r\n\r\n* Boost (SMK004)\r\n\r\n* Grow (SMK002)\r\n\r\n* Prosper + (SMK003)\r\n\r\nPossible values: SMK001, SMK004, SMK002, SMK003","example":"SMK001","uniqueKey":"productId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The product/tier the firm is subscribed to. Must be set when creating the firm and is optional when updating the firm.\r\n\r\nThe supported products are listed in order below, the identifier (in brackets) must be used.\r\n\r\n* Bill (SMK001)\r\n\r\n* Boost (SMK004)\r\n\r\n* Grow (SMK002)\r\n\r\n* Prosper + (SMK003)\r\n\r\nPossible values: SMK001, SMK004, SMK002, SMK003","example":"SMK001","uniqueKey":"productId.oneOf.1","typeLabel":"null"}],"uniqueKey":"productId","typeLabel":"string | null"},"addOnIds":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"addOnIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The optional add-ons the firm is subscribed to. Must be specified with an accompanying productId.\r\n\r\nThe supported add-ons are listed below, the identifier (listed in brackets) must be used.\r\n\r\n* Intake (ADD001)\r\n\r\n* AutoTime (ADD003)\r\n\r\n* FamilyPro (ADD004)\r\n\r\n* Api (ADD005)\r\n\r\n* Workflows (ADD006)\r\n\r\n* PowerBI (ADD007)\r\n\r\n* Archie (ADD008)\r\n\r\n* SSO (ADD010)\r\n\r\n* PracticeEvolve (ADD011)\r\n\r\n* CustomReporting (ADD012)\r\n\r\nPossible values: ADD001, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010, ADD011, ADD012","example":["ADD001","ADD003"],"uniqueKey":"addOnIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The optional add-ons the firm is subscribed to. Must be specified with an accompanying productId.\r\n\r\nThe supported add-ons are listed below, the identifier (listed in brackets) must be used.\r\n\r\n* Intake (ADD001)\r\n\r\n* AutoTime (ADD003)\r\n\r\n* FamilyPro (ADD004)\r\n\r\n* Api (ADD005)\r\n\r\n* Workflows (ADD006)\r\n\r\n* PowerBI (ADD007)\r\n\r\n* Archie (ADD008)\r\n\r\n* SSO (ADD010)\r\n\r\n* PracticeEvolve (ADD011)\r\n\r\n* CustomReporting (ADD012)\r\n\r\nPossible values: ADD001, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010, ADD011, ADD012","example":["ADD001","ADD003"],"uniqueKey":"addOnIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"addOnIds","typeLabel":"string[] | null"},"email":{"oneOf":[{"type":"string","description":"The email of the firm.\r\n\r\nOnly supported in AUS.","example":"john.smith@law.com","uniqueKey":"email.oneOf.0","typeLabel":"string"},{"type":"null","description":"The email of the firm.\r\n\r\nOnly supported in AUS.","example":"john.smith@law.com","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string | null"},"abn":{"oneOf":[{"type":"string","description":"For AU: Australian Business Number (ABN) of the firm.\r\n\r\nFor UK: Value-added Tax Number (VAT) of the firm.\r\n\r\nOnly supported in AU and UK.","example":"1234567890","uniqueKey":"abn.oneOf.0","typeLabel":"string"},{"type":"null","description":"For AU: Australian Business Number (ABN) of the firm.\r\n\r\nFor UK: Value-added Tax Number (VAT) of the firm.\r\n\r\nOnly supported in AU and UK.","example":"1234567890","uniqueKey":"abn.oneOf.1","typeLabel":"null"}],"uniqueKey":"abn","typeLabel":"string | null"},"acn":{"oneOf":[{"type":"string","description":"For AU: Australian Company Number (ACN) of the firm.\r\n\r\nFor UK: Company Registration Number (CRN) of the firm.\r\n\r\nOnly supported in AU and UK.","example":"1234567890","uniqueKey":"acn.oneOf.0","typeLabel":"string"},{"type":"null","description":"For AU: Australian Company Number (ACN) of the firm.\r\n\r\nFor UK: Company Registration Number (CRN) of the firm.\r\n\r\nOnly supported in AU and UK.","example":"1234567890","uniqueKey":"acn.oneOf.1","typeLabel":"null"}],"uniqueKey":"acn","typeLabel":"string | null"},"streetAddress":{"oneOf":[{"type":"object","description":"Street address of the firm.","properties":{"buildingLevel":{"oneOf":[{"type":"string","description":"Building level in address (if applicable).","example":"Level 1","uniqueKey":"streetAddress.oneOf.0.buildingLevel.oneOf.0","typeLabel":"string"},{"type":"null","description":"Building level in address (if applicable).","example":"Level 1","uniqueKey":"streetAddress.oneOf.0.buildingLevel.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.buildingLevel","typeLabel":"string | null"},"unitNumber":{"oneOf":[{"type":"string","description":"Unit number in address (if applicable).","example":"10","uniqueKey":"streetAddress.oneOf.0.unitNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit number in address (if applicable).","example":"10","uniqueKey":"streetAddress.oneOf.0.unitNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.unitNumber","typeLabel":"string | null"},"unitType":{"oneOf":[{"type":"string","description":"Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).","example":"Suite","uniqueKey":"streetAddress.oneOf.0.unitType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).","example":"Suite","uniqueKey":"streetAddress.oneOf.0.unitType.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.unitType","typeLabel":"string | null"},"streetNumber":{"oneOf":[{"type":"string","description":"Street number in address.","example":"100","uniqueKey":"streetAddress.oneOf.0.streetNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number in address.","example":"100","uniqueKey":"streetAddress.oneOf.0.streetNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.streetNumber","typeLabel":"string | null"},"streetName":{"oneOf":[{"type":"string","description":"Street name in address.","example":"Broad","uniqueKey":"streetAddress.oneOf.0.streetName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street name in address.","example":"Broad","uniqueKey":"streetAddress.oneOf.0.streetName.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.streetName","typeLabel":"string | null"},"streetType":{"oneOf":[{"type":"string","description":"Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.","example":"Street","uniqueKey":"streetAddress.oneOf.0.streetType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.","example":"Street","uniqueKey":"streetAddress.oneOf.0.streetType.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.streetType","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"type":"string","description":"First line of address.","example":"Level 1/10","uniqueKey":"streetAddress.oneOf.0.addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","description":"First line of address.","example":"Level 1/10","uniqueKey":"streetAddress.oneOf.0.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","description":"Second line of address (if applicable).","example":"100 Broad Street","uniqueKey":"streetAddress.oneOf.0.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of address (if applicable).","example":"100 Broad Street","uniqueKey":"streetAddress.oneOf.0.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"Chicago","uniqueKey":"streetAddress.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City, district, suburb, town, or village.","example":"Chicago","uniqueKey":"streetAddress.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State, province, or region.","example":"IL","uniqueKey":"streetAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region.","example":"IL","uniqueKey":"streetAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.state","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","description":"Zip or post code.","example":"60606","uniqueKey":"streetAddress.oneOf.0.zipCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Zip or post code.","example":"60606","uniqueKey":"streetAddress.oneOf.0.zipCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.zipCode","typeLabel":"string | null"},"county":{"oneOf":[{"type":"string","description":"County (if applicable)","example":"Berkshire","uniqueKey":"streetAddress.oneOf.0.county.oneOf.0","typeLabel":"string"},{"type":"null","description":"County (if applicable)","example":"Berkshire","uniqueKey":"streetAddress.oneOf.0.county.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.county","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"Locality (if applicable)","example":"Windsor","uniqueKey":"streetAddress.oneOf.0.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locality (if applicable)","example":"Windsor","uniqueKey":"streetAddress.oneOf.0.locality.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.locality","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country.","example":"United States","uniqueKey":"streetAddress.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country.","example":"United States","uniqueKey":"streetAddress.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.country","typeLabel":"string | null"},"careOf":{"oneOf":[{"type":"string","description":"Care of the addressee (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.careOf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Care of the addressee (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.careOf.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.careOf","typeLabel":"string | null"},"poBoxType":{"oneOf":[{"type":"string","description":"PO box type in address (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.poBoxType.oneOf.0","typeLabel":"string"},{"type":"null","description":"PO box type in address (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.poBoxType.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.poBoxType","typeLabel":"string | null"},"poBoxNumber":{"oneOf":[{"type":"string","description":"PO box Number in address (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.poBoxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"PO box Number in address (if applicable).","readOnly":true,"example":"","uniqueKey":"streetAddress.oneOf.0.poBoxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress.oneOf.0.poBoxNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"streetAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"streetAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"streetAddress","typeLabel":"object | null"},"mailingAddress":{"oneOf":[{"type":"object","description":"Mailing address of the firm.","properties":{"buildingLevel":{"oneOf":[{"type":"string","description":"Building level in address (if applicable).","example":"Level 1","uniqueKey":"mailingAddress.oneOf.0.buildingLevel.oneOf.0","typeLabel":"string"},{"type":"null","description":"Building level in address (if applicable).","example":"Level 1","uniqueKey":"mailingAddress.oneOf.0.buildingLevel.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.buildingLevel","typeLabel":"string | null"},"unitNumber":{"oneOf":[{"type":"string","description":"Unit number in address (if applicable).","example":"10","uniqueKey":"mailingAddress.oneOf.0.unitNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit number in address (if applicable).","example":"10","uniqueKey":"mailingAddress.oneOf.0.unitNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.unitNumber","typeLabel":"string | null"},"unitType":{"oneOf":[{"type":"string","description":"Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).","example":"Suite","uniqueKey":"mailingAddress.oneOf.0.unitType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).","example":"Suite","uniqueKey":"mailingAddress.oneOf.0.unitType.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.unitType","typeLabel":"string | null"},"streetNumber":{"oneOf":[{"type":"string","description":"Street number in address.","example":"100","uniqueKey":"mailingAddress.oneOf.0.streetNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street number in address.","example":"100","uniqueKey":"mailingAddress.oneOf.0.streetNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.streetNumber","typeLabel":"string | null"},"streetName":{"oneOf":[{"type":"string","description":"Street name in address.","example":"Broad","uniqueKey":"mailingAddress.oneOf.0.streetName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street name in address.","example":"Broad","uniqueKey":"mailingAddress.oneOf.0.streetName.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.streetName","typeLabel":"string | null"},"streetType":{"oneOf":[{"type":"string","description":"Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.","example":"Street","uniqueKey":"mailingAddress.oneOf.0.streetType.oneOf.0","typeLabel":"string"},{"type":"null","description":"Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.","example":"Street","uniqueKey":"mailingAddress.oneOf.0.streetType.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.streetType","typeLabel":"string | null"},"addressLine1":{"oneOf":[{"type":"string","description":"First line of address.","example":"Level 1/10","uniqueKey":"mailingAddress.oneOf.0.addressLine1.oneOf.0","typeLabel":"string"},{"type":"null","description":"First line of address.","example":"Level 1/10","uniqueKey":"mailingAddress.oneOf.0.addressLine1.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.addressLine1","typeLabel":"string | null"},"addressLine2":{"oneOf":[{"type":"string","description":"Second line of address (if applicable).","example":"100 Broad Street","uniqueKey":"mailingAddress.oneOf.0.addressLine2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Second line of address (if applicable).","example":"100 Broad Street","uniqueKey":"mailingAddress.oneOf.0.addressLine2.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.addressLine2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","description":"City, district, suburb, town, or village.","example":"Chicago","uniqueKey":"mailingAddress.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","description":"City, district, suburb, town, or village.","example":"Chicago","uniqueKey":"mailingAddress.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State, province, or region.","example":"IL","uniqueKey":"mailingAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region.","example":"IL","uniqueKey":"mailingAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.state","typeLabel":"string | null"},"zipCode":{"oneOf":[{"type":"string","description":"Zip or post code.","example":"60606","uniqueKey":"mailingAddress.oneOf.0.zipCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Zip or post code.","example":"60606","uniqueKey":"mailingAddress.oneOf.0.zipCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.zipCode","typeLabel":"string | null"},"county":{"oneOf":[{"type":"string","description":"County (if applicable)","example":"Berkshire","uniqueKey":"mailingAddress.oneOf.0.county.oneOf.0","typeLabel":"string"},{"type":"null","description":"County (if applicable)","example":"Berkshire","uniqueKey":"mailingAddress.oneOf.0.county.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.county","typeLabel":"string | null"},"locality":{"oneOf":[{"type":"string","description":"Locality (if applicable)","example":"Windsor","uniqueKey":"mailingAddress.oneOf.0.locality.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locality (if applicable)","example":"Windsor","uniqueKey":"mailingAddress.oneOf.0.locality.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.locality","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Country.","example":"United States","uniqueKey":"mailingAddress.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Country.","example":"United States","uniqueKey":"mailingAddress.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.country","typeLabel":"string | null"},"careOf":{"oneOf":[{"type":"string","description":"Care of the addressee (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.careOf.oneOf.0","typeLabel":"string"},{"type":"null","description":"Care of the addressee (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.careOf.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.careOf","typeLabel":"string | null"},"poBoxType":{"oneOf":[{"type":"string","description":"PO box type in address (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.poBoxType.oneOf.0","typeLabel":"string"},{"type":"null","description":"PO box type in address (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.poBoxType.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.poBoxType","typeLabel":"string | null"},"poBoxNumber":{"oneOf":[{"type":"string","description":"PO box Number in address (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.poBoxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"PO box Number in address (if applicable).","readOnly":true,"example":"","uniqueKey":"mailingAddress.oneOf.0.poBoxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress.oneOf.0.poBoxNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"mailingAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"mailingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"mailingAddress","typeLabel":"object | null"},"dxAddress":{"oneOf":[{"type":"object","description":"DX address of the firm.\r\n\r\nOnly supported in AUS.","properties":{"number":{"oneOf":[{"type":"string","description":"Direct Exchange number (if applicable).","example":"376","uniqueKey":"dxAddress.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Direct Exchange number (if applicable).","example":"376","uniqueKey":"dxAddress.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"dxAddress.oneOf.0.number","typeLabel":"string | null"},"exchange":{"oneOf":[{"type":"string","description":"Direct Exchange name.","example":"DX","uniqueKey":"dxAddress.oneOf.0.exchange.oneOf.0","typeLabel":"string"},{"type":"null","description":"Direct Exchange name.","example":"DX","uniqueKey":"dxAddress.oneOf.0.exchange.oneOf.1","typeLabel":"null"}],"uniqueKey":"dxAddress.oneOf.0.exchange","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"State, province, or region.","example":"NSW","uniqueKey":"dxAddress.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State, province, or region.","example":"NSW","uniqueKey":"dxAddress.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"dxAddress.oneOf.0.state","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"dxAddress.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"dxAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"dxAddress","typeLabel":"object | null"},"phone":{"oneOf":[{"type":"object","description":"Phone number of the firm.","properties":{"areaCode":{"oneOf":[{"type":"string","description":"Phone area code.","example":"555","uniqueKey":"phone.oneOf.0.areaCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone area code.","example":"555","uniqueKey":"phone.oneOf.0.areaCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone.oneOf.0.areaCode","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Phone number (excluding area code).","example":"1234567","uniqueKey":"phone.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number (excluding area code).","example":"1234567","uniqueKey":"phone.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone.oneOf.0.number","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"phone.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"phone","typeLabel":"object | null"},"fax":{"oneOf":[{"type":"object","description":"Fax number of the firm.","properties":{"areaCode":{"oneOf":[{"type":"string","description":"Phone area code.","example":"555","uniqueKey":"fax.oneOf.0.areaCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone area code.","example":"555","uniqueKey":"fax.oneOf.0.areaCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"fax.oneOf.0.areaCode","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Phone number (excluding area code).","example":"1234567","uniqueKey":"fax.oneOf.0.number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number (excluding area code).","example":"1234567","uniqueKey":"fax.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"fax.oneOf.0.number","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"fax.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"fax.oneOf.1","typeLabel":"null"}],"uniqueKey":"fax","typeLabel":"object | null"},"logo":{"oneOf":[{"type":"string","description":"Logo of the firm.","example":"https://example-logo-url.com/image","uniqueKey":"logo.oneOf.0","typeLabel":"string"},{"type":"null","description":"Logo of the firm.","example":"https://example-logo-url.com/image","uniqueKey":"logo.oneOf.1","typeLabel":"null"}],"uniqueKey":"logo","typeLabel":"string | null"},"stylingDetails":{"oneOf":[{"type":"object","description":"Styling details of the firm.","properties":{"primaryColorHexCode":{"oneOf":[{"type":"string","description":"Firm's primary color hex code.","example":"#FF000000","uniqueKey":"stylingDetails.oneOf.0.primaryColorHexCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Firm's primary color hex code.","example":"#FF000000","uniqueKey":"stylingDetails.oneOf.0.primaryColorHexCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"stylingDetails.oneOf.0.primaryColorHexCode","typeLabel":"string | null"},"secondaryColorHexCode":{"oneOf":[{"type":"string","description":"Firm's secondary color hex code.","example":"#FF000000","uniqueKey":"stylingDetails.oneOf.0.secondaryColorHexCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Firm's secondary color hex code.","example":"#FF000000","uniqueKey":"stylingDetails.oneOf.0.secondaryColorHexCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"stylingDetails.oneOf.0.secondaryColorHexCode","typeLabel":"string | null"},"fontFamilyName":{"oneOf":[{"type":"string","description":"Firm's font family name.","example":"Open Sans","uniqueKey":"stylingDetails.oneOf.0.fontFamilyName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Firm's font family name.","example":"Open Sans","uniqueKey":"stylingDetails.oneOf.0.fontFamilyName.oneOf.1","typeLabel":"null"}],"uniqueKey":"stylingDetails.oneOf.0.fontFamilyName","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"stylingDetails.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"stylingDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"stylingDetails","typeLabel":"object | null"},"licenceNumbers":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"state":{"oneOf":[{"type":"string","description":"State associated to the licence.","example":"IL","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].state.oneOf.0","typeLabel":"string"},{"type":"null","description":"State associated to the licence.","example":"IL","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].state.oneOf.1","typeLabel":"null"}],"uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].state","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"Type of the licence.","example":"","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Type of the licence.","example":"","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].type","typeLabel":"string | null"},"number":{"oneOf":[{"type":"string","description":"Licence number.","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Licence number.","uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].number.oneOf.1","typeLabel":"null"}],"uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX].number","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"licenceNumbers.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Licence numbers of the firm.","uniqueKey":"licenceNumbers.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"state":{"oneOf":[{"type":"string","description":"State associated to the licence.","example":"IL"},{"type":"null","description":"State associated to the licence.","example":"IL"}]},"type":{"oneOf":[{"type":"string","description":"Type of the licence.","example":""},{"type":"null","description":"Type of the licence.","example":""}]},"number":{"oneOf":[{"type":"string","description":"Licence number."},{"type":"null","description":"Licence number."}]}},"additionalProperties":false},"description":"Licence numbers of the firm.","uniqueKey":"licenceNumbers.oneOf.1","typeLabel":"null"}],"uniqueKey":"licenceNumbers","typeLabel":"object[] | null"},"createdDate":{"oneOf":[{"type":"string","description":"The date when the firm was created in UTC.","format":"date-time","example":"2024-01-15T10:30:00Z","uniqueKey":"createdDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"The date when the firm was created in UTC.","format":"date-time","example":"2024-01-15T10:30:00Z","uniqueKey":"createdDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"createdDate","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"href":"\u003cstring>","relation":"\u003cstring>","method":"GET","self":{"id":"\u003cstring>","href":"\u003cstring>","relation":"\u003cstring>","method":"GET"},"id":"f4ff1eff-b7fe-4d46-4e46-01d985838d76","versionId":"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8","owner":"Smokeball","name":"Brown LLC","status":{"status":"Active","statusMessage":"\u003cstring>"},"productId":"SMK001","addOnIds":["ADD001","ADD003"],"email":"john.smith@law.com","abn":"1234567890","acn":"1234567890","streetAddress":{"buildingLevel":"Level 1","unitNumber":"10","unitType":"Suite","streetNumber":"100","streetName":"Broad","streetType":"Street","addressLine1":"Level 1/10","addressLine2":"100 Broad Street","city":"Chicago","state":"IL","zipCode":"60606","county":"Berkshire","locality":"Windsor","country":"United States","careOf":"","poBoxType":"","poBoxNumber":""},"mailingAddress":{"buildingLevel":"Level 1","unitNumber":"10","unitType":"Suite","streetNumber":"100","streetName":"Broad","streetType":"Street","addressLine1":"Level 1/10","addressLine2":"100 Broad Street","city":"Chicago","state":"IL","zipCode":"60606","county":"Berkshire","locality":"Windsor","country":"United States","careOf":"","poBoxType":"","poBoxNumber":""},"dxAddress":{"number":"376","exchange":"DX","state":"NSW"},"phone":{"areaCode":"555","number":"1234567"},"fax":{"areaCode":"555","number":"1234567"},"logo":"https://example-logo-url.com/image","stylingDetails":{"primaryColorHexCode":"#FF000000","secondaryColorHexCode":"#FF000000","fontFamilyName":"Open Sans"},"licenceNumbers":[{"state":"IL","type":"","number":"\u003cstring>"}],"createdDate":"2024-01-15T10:30:00Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"5705be44-ecfe-43e9-a90e-38ea20af6aa5":{"description":"When firm does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ed4ed28c-ced2-4e57-934b-63036aa00efc":{"api-key":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api-key"},"token":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"cognito_user_pools","scopes":[],"schemeName":"token"}}},"servers":{"1115e230-afa6-43e1-bcf2-af1e747375f0":{"url":"https://api.smokeball.com"},"1785f238-40d5-4015-a51e-d87561a47c2f":{"url":"https://api.smokeball.com.au"},"28d84b45-11d8-4f57-92d2-88a3fe6659f3":{"url":"https://api.smokeball.co.uk"},"9bb3f04e-98f2-4154-9375-d6eccd072fdf":{"url":"https://stagingapi.smokeball.com"},"6b2c171b-1851-4b52-89e9-8af4bc0f93d0":{"url":"https://stagingapi.smokeball.com.au"},"45158a02-bc8f-4d48-b521-bd140b06aa83":{"url":"https://stagingapi.smokeball.co.uk"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","scopes":[],"schemeName":"api-key"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"x-api-key"},{"scheme":{"type":"apiKey","name":"Authorization","in":"header","x-amazon-apigateway-authtype":"cognito_user_pools","scopes":[],"schemeName":"token"},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"token","name":"Authorization"}],"title":"api-key \u0026 token"}]},"originalFileLocation":"openapi.json"},"subdomain":"smokeball","siteName":"Smokeball","title":"Get firm - Smokeball","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T00:36:17.012Z","originalFileLocation":"api-reference/firm/get-firm.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=\"light\"}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=\"Retrieves the details of the firm associated with the authenticated client.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Smokeball\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_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/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get firm - Smokeball\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the details of the firm associated with the authenticated client.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Smokeball\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smokeball.com/api-reference/firm/get-firm\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smokeball.mintlify.app/_mintlify/api/og/v2?division=Firm\u0026amp;title=Get+firm\u0026amp;description=Retrieves+the+details+of+the+firm+associated+with+the+authenticated+client.\u0026amp;theme=72503ad8812ca0e367fb42df\u0026amp;signature=1d0b5f63116aff940964ae2467b7862943cf614bfc7d7685a80f4e34cb3e525b\">\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 firm - Smokeball\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the details of the firm associated with the authenticated client.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smokeball.mintlify.app/_mintlify/api/og/v2?division=Firm\u0026amp;title=Get+firm\u0026amp;description=Retrieves+the+details+of+the+firm+associated+with+the+authenticated+client.\u0026amp;theme=72503ad8812ca0e367fb42df\u0026amp;signature=1d0b5f63116aff940964ae2467b7862943cf614bfc7d7685a80f4e34cb3e525b\">\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/smokeball/YT9oRRLb2fl_fJ6Z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Smokeball\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#f2600c\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smokeball.com/api-reference/firm/get-firm\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/firm/get-firm.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smokeball.com/#organization\",\"name\":\"Smokeball\",\"url\":\"https://docs.smokeball.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smokeball/M3xU16wx3zLWrCy3/logo/light.svg?fit=max\u0026auto=format\u0026n=M3xU16wx3zLWrCy3\u0026q=85\u0026s=9742e65825b3575ca562541e0e7571d3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smokeball.com#website\",\"name\":\"Smokeball\",\"url\":\"https://docs.smokeball.com\",\"publisher\":{\"@id\":\"https://docs.smokeball.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smokeball.com/api-reference/firm/get-firm#webpage\",\"url\":\"https://docs.smokeball.com/api-reference/firm/get-firm\",\"name\":\"Get firm\",\"description\":\"Retrieves the details of the firm associated with the authenticated client.\",\"dateModified\":\"2026-10-23T00:36:17.012Z\",\"isPartOf\":{\"@id\":\"https://docs.smokeball.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smokeball.com/api-reference/firm/get-firm#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smokeball.com/api-reference/firm/get-firm#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"APIs\",\"item\":\"https://docs.smokeball.com/api-reference/activity-codes/get-an-activity-code\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get firm\",\"item\":\"https://docs.smokeball.com/api-reference/firm/get-firm\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smokeball.com/api-reference/firm/get-firm#apireference\",\"headline\":\"Get firm\",\"name\":\"Get firm\",\"description\":\"Retrieves the details of the firm associated with the authenticated client.\",\"url\":\"https://docs.smokeball.com/api-reference/firm/get-firm\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smokeball.com/api-reference/firm/get-firm#webpage\"},\"dateModified\":\"2026-10-23T00:36:17.012Z\",\"publisher\":{\"@id\":\"https://docs.smokeball.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smokeball.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Smokeball\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Smokeball","nav":{"global":{"anchors":[{"anchor":"Marketplace","icon":"store","href":"https://marketplace.smokeball.com"},{"anchor":"Blog","icon":"newspaper","href":"https://www.smokeball.com/blog"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/docs/platform-docs/va20w41tid7py-get-started-overview"}]},{"tab":"API","groups":[{"group":"Documentation","pages":[{"group":"Getting Started","icon":"hand-wave","pages":[{"title":"Introduction","href":"/docs/api-docs/1e13a13124aee-introduction"},{"title":"Base URLs","href":"/docs/api-docs/z2q8vla6b77g8-base-urls"},{"title":"Rate Limits","href":"/docs/api-docs/vj4jovpoopdov-rate-limits"}]},{"group":"Authentication","icon":"lock","pages":[{"title":"Overview","href":"/docs/api-docs/c916c683c136e-authentication-overview"},{"title":"Authorization Code Grant","href":"/docs/api-docs/2t26gcuuqf1wk-authorization-code-grant"},{"title":"Client Credentials Grant","href":"/docs/api-docs/h72024p76i8e1-client-credentials-grant"},{"title":"Scopes","href":"/docs/api-docs/qf83nz2scopes-scopes"},{"title":"Logout Endpoint","href":"/docs/api-docs/9de98u0xqsckx-logout-endpoint"}]},{"title":"Making Requests","icon":"globe","href":"/docs/api-docs/ivmfjbc61tvjs-making-requests"},{"title":"Errors","icon":"circle-exclamation","href":"/docs/api-docs/e4f5a6b7c8d9e-errors"},{"title":"Searching","icon":"magnifying-glass","href":"/docs/api-docs/272770a37d359-searching"},{"title":"Plugins","icon":"plug","href":"/docs/api-docs/scmo7vmtln5hm-plugins"},{"title":"Webhooks","icon":"webhook","href":"/docs/api-docs/wivbkstcwngb5-webhooks"}]},{"group":"Tutorials","pages":[{"title":"Matters","icon":"book","href":"/docs/api-docs/voyymdyjn5yp3-matters"},{"title":"Leads","icon":"book","href":"/docs/api-docs/plu740klph0ho-leads"},{"title":"Files and Folders","icon":"book","href":"/docs/api-docs/wivbkstcwngb5-files-folders"},{"title":"Layouts","icon":"book","href":"/docs/api-docs/0d3adba1494ce-layouts"}]},{"group":"APIs","pages":[{"group":"Activity Codes","pages":[{"title":"Get an activity code","deprecated":null,"version":null,"openapi":"/openapi.json get /activitycodes/{id}","href":"/api-reference/activity-codes/get-an-activity-code"},{"title":"Update an activity code","deprecated":null,"version":null,"openapi":"/openapi.json put /activitycodes/{id}","href":"/api-reference/activity-codes/update-an-activity-code"},{"title":"Delete an activity code","deprecated":null,"version":null,"openapi":"/openapi.json delete /activitycodes/{id}","href":"/api-reference/activity-codes/delete-an-activity-code"},{"title":"Get activity codes","deprecated":null,"version":null,"openapi":"/openapi.json get /activitycodes","href":"/api-reference/activity-codes/get-activity-codes"},{"title":"Create an activity code","deprecated":null,"version":null,"openapi":"/openapi.json post /activitycodes","href":"/api-reference/activity-codes/create-an-activity-code"}]},{"group":"Authorization","pages":[{"title":"Get authorization groups","deprecated":null,"version":null,"openapi":"/openapi.json get /groups","href":"/api-reference/authorization/get-authorization-groups"},{"title":"Create an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json post /groups","href":"/api-reference/authorization/create-an-authorization-group"},{"title":"Get an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json get /groups/{id}","href":"/api-reference/authorization/get-an-authorization-group"},{"title":"Update an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json put /groups/{id}","href":"/api-reference/authorization/update-an-authorization-group"},{"title":"Deletes an authorization group","deprecated":null,"version":null,"openapi":"/openapi.json delete /groups/{id}","href":"/api-reference/authorization/deletes-an-authorization-group"},{"title":"Get an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json get /policies/{reference}","href":"/api-reference/authorization/get-an-authorization-policy"},{"title":"Update an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json put /policies/{reference}","href":"/api-reference/authorization/update-an-authorization-policy"},{"title":"Create an authorization policy","deprecated":null,"version":null,"openapi":"/openapi.json post /policies","href":"/api-reference/authorization/create-an-authorization-policy"}]},{"group":"Bank Accounts","pages":[{"title":"Get a bank account","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}","href":"/api-reference/bank-accounts/get-a-bank-account"},{"title":"Get bank accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts","href":"/api-reference/bank-accounts/get-bank-accounts"},{"title":"Get bank account matter balances","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}/matter-balances","href":"/api-reference/bank-accounts/get-bank-account-matter-balances"},{"title":"Get a protected bank account balance","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{id}/protected-balances/{protectionId}","href":"/api-reference/bank-accounts/get-a-protected-bank-account-balance"},{"title":"Protect bank account funds","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/protect-funds","href":"/api-reference/bank-accounts/protect-bank-account-funds"},{"title":"Unprotect bank account funds","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/unprotect-funds/{protectionId}","href":"/api-reference/bank-accounts/unprotect-bank-account-funds"},{"title":"Create a requisition","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{id}/requisitions","href":"/api-reference/bank-accounts/create-a-requisition"},{"title":"Get transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{bankAccountId}/transactions","href":"/api-reference/bank-accounts/get-transactions"},{"title":"Create a transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /bankaccounts/{bankAccountId}/transactions","href":"/api-reference/bank-accounts/create-a-transaction"},{"title":"Get a transaction","deprecated":null,"version":null,"openapi":"/openapi.json get /bankaccounts/{bankAccountId}/transactions/{id}","href":"/api-reference/bank-accounts/get-a-transaction"}]},{"group":"Contacts","pages":[{"title":"Get contact relations","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}/relations","href":"/api-reference/contacts/get-contact-relations"},{"title":"Create a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{contactId}/relations","href":"/api-reference/contacts/create-a-contact-relation"},{"title":"Get a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/get-a-contact-relation"},{"title":"Update a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json put /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/update-a-contact-relation"},{"title":"Delete a contact relation","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{contactId}/relations/{relatedContactId}","href":"/api-reference/contacts/delete-a-contact-relation"},{"title":"Get contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/get-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json put /contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Get contacts by ids","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/batch","href":"/api-reference/contacts/get-contacts-by-ids"},{"title":"Get contact tags","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}/tags","href":"/api-reference/contacts/get-contact-tags"},{"title":"Add tags to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/tags","href":"/api-reference/contacts/add-tags-to-a-contact"},{"title":"Remove tags from a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}/tags/{tagId}","href":"/api-reference/contacts/remove-tags-from-a-contact"}]},{"group":"Events","pages":[{"title":"Get events","deprecated":null,"version":null,"openapi":"/openapi.json get /events","href":"/api-reference/events/get-events"},{"title":"Create event","deprecated":null,"version":null,"openapi":"/openapi.json post /events","href":"/api-reference/events/create-event"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi.json get /events/{eventId}","href":"/api-reference/events/get-an-event"},{"title":"Update event","deprecated":null,"version":null,"openapi":"/openapi.json put /events/{eventId}","href":"/api-reference/events/update-event"},{"title":"Delete event","deprecated":null,"version":null,"openapi":"/openapi.json delete /events/{eventId}","href":"/api-reference/events/delete-event"},{"title":"Gets reminders for an event","deprecated":null,"version":null,"openapi":"/openapi.json get /events/{eventId}/reminders","href":"/api-reference/events/gets-reminders-for-an-event"},{"title":"Create reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json post /events/{eventId}/reminders","href":"/api-reference/events/create-reminder-for-an-event"},{"title":"Update a reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json put /events/{eventId}/reminders/{reminderId}","href":"/api-reference/events/update-a-reminder-for-an-event"},{"title":"Delete reminder for an event","deprecated":null,"version":null,"openapi":"/openapi.json delete /events/{eventId}/reminders/{reminderId}","href":"/api-reference/events/delete-reminder-for-an-event"}]},{"group":"Expenses","pages":[{"title":"Get expenses","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/expenses","href":"/api-reference/expenses/get-expenses"},{"title":"Create an expense","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/expenses","href":"/api-reference/expenses/create-an-expense"},{"title":"Get an expense","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/get-an-expense"},{"title":"Update an expense","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/update-an-expense"},{"title":"Delete an expense","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/delete-an-expense"},{"title":"Patch an expense","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/expenses/{id}","href":"/api-reference/expenses/patch-an-expense"}]},{"group":"Fees","pages":[{"title":"Get fees","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/fees","href":"/api-reference/fees/get-fees"},{"title":"Create a fee","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/fees","href":"/api-reference/fees/create-a-fee"},{"title":"Get a fee","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/fees/{id}","href":"/api-reference/fees/get-a-fee"},{"title":"Update a fee","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/fees/{id}","href":"/api-reference/fees/update-a-fee"},{"title":"Delete a fee","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/fees/{id}","href":"/api-reference/fees/delete-a-fee"},{"title":"Patch a fee","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/fees/{id}","href":"/api-reference/fees/patch-a-fee"}]},{"group":"Files","pages":[{"title":"Get files on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files","href":"/api-reference/files/get-files-on-a-matter"},{"title":"Add file to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files","href":"/api-reference/files/add-file-to-a-matter"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/get-a-file"},{"title":"Upload/update version or metadata of a file","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/uploadupdate-version-or-metadata-of-a-file"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/delete-a-file"},{"title":"Patch a file","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/documents/files/{fileId}","href":"/api-reference/files/patch-a-file"},{"title":"Get download url for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/download","href":"/api-reference/files/get-download-url-for-a-file"},{"title":"Get upload url for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/upload","href":"/api-reference/files/get-upload-url-for-a-file"},{"title":"Get file history on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/history","href":"/api-reference/files/get-file-history-on-a-matter"},{"title":"Add files to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files/bulk","href":"/api-reference/files/add-files-to-a-matter"},{"title":"Get preview info for a file","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/preview","href":"/api-reference/files/get-preview-info-for-a-file"},{"title":"Get or create a preview","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/files/{fileId}/preview","href":"/api-reference/files/get-or-create-a-preview"},{"title":"Get preview info for a file by document version","description":"Returns a presigned URL to the PDF preview of a specific document version of the file.\r\nThe URL is valid for 1 day from the time of the request.","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/files/{fileId}/preview/{documentVersionId}","href":"/api-reference/files/get-preview-info-for-a-file-by-document-version"}]},{"group":"Firm","pages":[{"title":"Get firm","deprecated":null,"version":null,"openapi":"/openapi.json get /firm","href":"/api-reference/firm/get-firm"},{"title":"Update firm","description":"Updates firm details for the current authenticated client.","deprecated":null,"version":null,"openapi":"/openapi.json put /firm","href":"/api-reference/firm/update-firm"},{"title":"Create firm","deprecated":null,"version":null,"openapi":"/openapi.json post /firm","href":"/api-reference/firm/create-firm"},{"title":"Get firm user mappings","deprecated":null,"version":null,"openapi":"/openapi.json get /firmusers","href":"/api-reference/firm/get-firm-user-mappings"},{"title":"Get firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json get /firmusers/{id}","href":"/api-reference/firm/get-firm-user-mapping"},{"title":"Update firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json put /firmusers/{id}","href":"/api-reference/firm/update-firm-user-mapping"},{"title":"Delete firm user mapping","deprecated":null,"version":null,"openapi":"/openapi.json delete /firmusers/{id}","href":"/api-reference/firm/delete-firm-user-mapping"}]},{"group":"Folders","pages":[{"title":"Get folders/files under root folder","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders","href":"/api-reference/folders/get-foldersfiles-under-root-folder"},{"title":"Create a folder","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/documents/folders","href":"/api-reference/folders/create-a-folder"},{"title":"Get folders/files under a folder","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/get-foldersfiles-under-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/update-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/delete-a-folder"},{"title":"Patch a folder","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/documents/folders/{folderId}","href":"/api-reference/folders/patch-a-folder"},{"title":"Get folder path hierarchy","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}/path","href":"/api-reference/folders/get-folder-path-hierarchy"},{"title":"Get folder history on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/documents/folders/{folderId}/history","href":"/api-reference/folders/get-folder-history-on-a-matter"}]},{"group":"Integrated Search","pages":[{"title":"Get mapping","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/integrated-search/mapping","href":"/api-reference/integrated-search/get-mapping"}]},{"group":"Invitations","pages":[{"title":"Search invitations","deprecated":null,"version":null,"openapi":"/openapi.json get /invitations","href":"/api-reference/invitations/search-invitations"},{"title":"Invite a person to join the firm","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations","href":"/api-reference/invitations/invite-a-person-to-join-the-firm"},{"title":"Get an invitation","deprecated":null,"version":null,"openapi":"/openapi.json get /invitations/{id}","href":"/api-reference/invitations/get-an-invitation"},{"title":"Cancel an invitation","deprecated":null,"version":null,"openapi":"/openapi.json delete /invitations/{id}","href":"/api-reference/invitations/cancel-an-invitation"},{"title":"Resend an invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations/{id}/resend","href":"/api-reference/invitations/resend-an-invitation"},{"title":"Accept an invitation","deprecated":null,"version":null,"openapi":"/openapi.json post /invitations/{id}/accept","href":"/api-reference/invitations/accept-an-invitation"}]},{"group":"Invoices","pages":[{"title":"Get invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices/{invoiceId}","href":"/api-reference/invoices/get-an-invoice"},{"title":"Get download url for an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/invoices/{invoiceId}/download","href":"/api-reference/invoices/get-download-url-for-an-invoice"}]},{"group":"Layout Designs","pages":[{"title":"Get layout designs","deprecated":null,"version":null,"openapi":"/openapi.json get /layouts","href":"/api-reference/layout-designs/get-layout-designs"},{"title":"Get a layout design","deprecated":null,"version":null,"openapi":"/openapi.json get /layouts/{id}","href":"/api-reference/layout-designs/get-a-layout-design"}]},{"group":"Layout Matter Items","pages":[{"title":"Get layouts","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts","href":"/api-reference/layout-matter-items/get-layouts"},{"title":"Add a new layout","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/layouts","href":"/api-reference/layout-matter-items/add-a-new-layout"},{"title":"Get a layout","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/get-a-layout"},{"title":"Remove a layout","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/remove-a-layout"},{"title":"Merge a layout","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/layouts/{itemId}","href":"/api-reference/layout-matter-items/merge-a-layout"},{"title":"Get layout contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/get-layout-contacts"},{"title":"Add a contact to a layout","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/add-a-contact-to-a-layout"},{"title":"Remove a contact from a layout","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/layouts/{itemId}/contacts","href":"/api-reference/layout-matter-items/remove-a-contact-from-a-layout"}]},{"group":"Matter Items","pages":[{"title":"Get items on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/items","href":"/api-reference/matter-items/get-items-on-a-matter"},{"title":"Get an item on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/items/{id}","href":"/api-reference/matter-items/get-an-item-on-a-matter"}]},{"group":"Matter Types","pages":[{"title":"Get matter types","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes","href":"/api-reference/matter-types/get-matter-types"},{"title":"Get a matter type","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes/{id}","href":"/api-reference/matter-types/get-a-matter-type"},{"title":"Get matter types categories","deprecated":null,"version":null,"openapi":"/openapi.json get /mattertypes/categories","href":"/api-reference/matter-types/get-matter-types-categories"}]},{"group":"Matters","pages":[{"title":"Get the archive for a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/archive","href":"/api-reference/matters/get-the-archive-for-a-matter"},{"title":"Update an archive for a matter.","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/archive","href":"/api-reference/matters/update-an-archive-for-a-matter"},{"title":"Patch an archive for a matter","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/archive","href":"/api-reference/matters/patch-an-archive-for-a-matter"},{"title":"Get matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/get-matter-billing-configuration"},{"title":"Update matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/update-matter-billing-configuration"},{"title":"Patch matter billing configuration","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/billingconfiguration","href":"/api-reference/matters/patch-matter-billing-configuration"},{"title":"Get matters","deprecated":null,"version":null,"openapi":"/openapi.json get /matters","href":"/api-reference/matters/get-matters"},{"title":"Create a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters","href":"/api-reference/matters/create-a-matter"},{"title":"Get a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}","href":"/api-reference/matters/get-a-matter"},{"title":"Update a matter","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}","href":"/api-reference/matters/update-a-matter"},{"title":"Delete a matter","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}","href":"/api-reference/matters/delete-a-matter"},{"title":"Patch a matter","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}","href":"/api-reference/matters/patch-a-matter"},{"title":"Get matter tags","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/tags","href":"/api-reference/matters/get-matter-tags"},{"title":"Add tags to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/tags","href":"/api-reference/matters/add-tags-to-a-matter"},{"title":"Remove tags from a matter","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/tags/{tagId}","href":"/api-reference/matters/remove-tags-from-a-matter"}]},{"group":"Memos","pages":[{"title":"Get memos on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/memos","href":"/api-reference/memos/get-memos-on-a-matter"},{"title":"Create a memo on a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/memos","href":"/api-reference/memos/create-a-memo-on-a-matter"},{"title":"Get a memo","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/memos/{id}","href":"/api-reference/memos/get-a-memo"},{"title":"Update a memo","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/memos/{id}","href":"/api-reference/memos/update-a-memo"},{"title":"Delete a memo","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/memos/{id}","href":"/api-reference/memos/delete-a-memo"}]},{"group":"Notifications","pages":[{"title":"Get a notification","deprecated":null,"version":null,"openapi":"/openapi.json get /notifications/{id}","href":"/api-reference/notifications/get-a-notification"},{"title":"Create a notification","deprecated":null,"version":null,"openapi":"/openapi.json post /notifications","href":"/api-reference/notifications/create-a-notification"}]},{"group":"Plugins","pages":[{"title":"Get a plugin","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}","href":"/api-reference/plugins/get-a-plugin"},{"title":"Update existing plugin","deprecated":null,"version":null,"openapi":"/openapi.json put /plugins/{pluginId}","href":"/api-reference/plugins/update-existing-plugin"},{"title":"Delete existing plugin","deprecated":null,"version":null,"openapi":"/openapi.json delete /plugins/{pluginId}","href":"/api-reference/plugins/delete-existing-plugin"},{"title":"Get plugins","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins","href":"/api-reference/plugins/get-plugins"},{"title":"Create a new plugin","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins","href":"/api-reference/plugins/create-a-new-plugin"},{"title":"Request plugin URL","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins/{pluginId}/url","href":"/api-reference/plugins/request-plugin-url"},{"title":"Get a plugin subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}/subscriptions/{id}","href":"/api-reference/plugins/get-a-plugin-subscription"},{"title":"Unsubscribes account from plugin","deprecated":null,"version":null,"openapi":"/openapi.json delete /plugins/{pluginId}/subscriptions/{id}","href":"/api-reference/plugins/unsubscribes-account-from-plugin"},{"title":"Get plugin subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /plugins/{pluginId}/subscriptions","href":"/api-reference/plugins/get-plugin-subscriptions"},{"title":"Subscribe account to plugin","deprecated":null,"version":null,"openapi":"/openapi.json post /plugins/{pluginId}/subscriptions","href":"/api-reference/plugins/subscribe-account-to-plugin"}]},{"group":"Portal","pages":[{"title":"Creates a portal task","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/portal/tasks","href":"/api-reference/portal/creates-a-portal-task"},{"title":"Sends a portal message","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/portal/messages","href":"/api-reference/portal/sends-a-portal-message"},{"title":"Patch a portal task","deprecated":null,"version":null,"openapi":"/openapi.json patch /matters/{matterId}/portal/tasks/{taskId}","href":"/api-reference/portal/patch-a-portal-task"}]},{"group":"Referral Types","pages":[{"title":"Get referral types","deprecated":null,"version":null,"openapi":"/openapi.json get /referraltypes","href":"/api-reference/referral-types/get-referral-types"},{"title":"Get a referral type","deprecated":null,"version":null,"openapi":"/openapi.json get /referraltypes/{id}","href":"/api-reference/referral-types/get-a-referral-type"}]},{"group":"Relationships","pages":[{"title":"Get relationships on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{roleId}/relationships","href":"/api-reference/relationships/get-relationships-on-a-matter"},{"title":"Add relationship to a role","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/roles/{roleId}/relationships","href":"/api-reference/relationships/add-relationship-to-a-role"},{"title":"Get relationship on a role","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/get-relationship-on-a-role"},{"title":"Update a relationship","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/update-a-relationship"},{"title":"Remove relationship from a role in a matter.","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/roles/{roleId}/relationships/{id}","href":"/api-reference/relationships/remove-relationship-from-a-role-in-a-matter"}]},{"group":"Roles","pages":[{"title":"Get roles on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles","href":"/api-reference/roles/get-roles-on-a-matter"},{"title":"Add role to a matter","deprecated":null,"version":null,"openapi":"/openapi.json post /matters/{matterId}/roles","href":"/api-reference/roles/add-role-to-a-matter"},{"title":"Get role on a matter","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/roles/{id}","href":"/api-reference/roles/get-role-on-a-matter"},{"title":"Update role on a matter","deprecated":null,"version":null,"openapi":"/openapi.json put /matters/{matterId}/roles/{id}","href":"/api-reference/roles/update-role-on-a-matter"},{"title":"Remove role from a matter","deprecated":null,"version":null,"openapi":"/openapi.json delete /matters/{matterId}/roles/{id}","href":"/api-reference/roles/remove-role-from-a-matter"}]},{"group":"Search","pages":[{"title":"Search files with advanced filters","deprecated":null,"version":null,"openapi":"/openapi.json post /search/files","href":"/api-reference/search/search-files-with-advanced-filters"}]},{"group":"Staff","pages":[{"title":"Search firm staff members","deprecated":null,"version":null,"openapi":"/openapi.json get /staff","href":"/api-reference/staff/search-firm-staff-members"},{"title":"Create firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json post /staff","href":"/api-reference/staff/create-firm-staff-member"},{"title":"Get firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json get /staff/{id}","href":"/api-reference/staff/get-firm-staff-member"},{"title":"Update firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json put /staff/{id}","href":"/api-reference/staff/update-firm-staff-member"},{"title":"Deletes a firm staff member","deprecated":null,"version":null,"openapi":"/openapi.json delete /staff/{id}","href":"/api-reference/staff/deletes-a-firm-staff-member"}]},{"group":"Stages","pages":[{"title":"Get stage to matter mappings in the firm","deprecated":null,"version":null,"openapi":"/openapi.json get /stages","href":"/api-reference/stages/get-stage-to-matter-mappings-in-the-firm"},{"title":"Get a matter stage information","deprecated":null,"version":null,"openapi":"/openapi.json get /matters/{matterId}/stages","href":"/api-reference/stages/get-a-matter-stage-information"},{"title":"Get stage sets for the firm","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets","href":"/api-reference/stages/get-stage-sets-for-the-firm"},{"title":"Get a stage set","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets/{id}","href":"/api-reference/stages/get-a-stage-set"},{"title":"Get a stage on a stage set","deprecated":null,"version":null,"openapi":"/openapi.json get /stagesets/{stageSetId}/stages/{id}","href":"/api-reference/stages/get-a-stage-on-a-stage-set"}]},{"group":"Tasks","pages":[{"title":"Get a subtask","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/get-a-subtask"},{"title":"Update a subtask","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/update-a-subtask"},{"title":"Delete a subtask","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{taskId}/subtasks/{id}","href":"/api-reference/tasks/delete-a-subtask"},{"title":"Get subtasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/subtasks","href":"/api-reference/tasks/get-subtasks"},{"title":"Create a subtask","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{taskId}/subtasks","href":"/api-reference/tasks/create-a-subtask"},{"title":"Get task documents","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/documents","href":"/api-reference/tasks/get-task-documents"},{"title":"Create a task document","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{taskId}/documents","href":"/api-reference/tasks/create-a-task-document"},{"title":"Get a task document","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{taskId}/documents/{id}","href":"/api-reference/tasks/get-a-task-document"},{"title":"Delete a task document","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{taskId}/documents/{id}","href":"/api-reference/tasks/delete-a-task-document"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{id}","href":"/api-reference/tasks/get-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{id}","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Get tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks","href":"/api-reference/tasks/get-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks","href":"/api-reference/tasks/create-a-task"}]},{"group":"Users","pages":[{"title":"Get user registrations","deprecated":null,"version":null,"openapi":"/openapi.json get /users/registrations","href":"/api-reference/users/get-user-registrations"},{"title":"Get a user","deprecated":null,"version":null,"openapi":"/openapi.json get /users/{id}","href":"/api-reference/users/get-a-user"},{"title":"Remove a user","deprecated":null,"version":null,"openapi":"/openapi.json delete /users/{id}","href":"/api-reference/users/remove-a-user"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi.json post /users","href":"/api-reference/users/create-a-user"},{"title":"Resend sign-in credentials","deprecated":null,"version":null,"openapi":"/openapi.json post /users/{id}/invite","href":"/api-reference/users/resend-sign-in-credentials"}]},{"group":"Webhooks","pages":[{"title":"Get event types","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/types","href":"/api-reference/webhooks/get-event-types"},{"title":"Get webhook subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/get-webhook-subscriptions"},{"title":"Create new webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-new-webhook-subscription"},{"title":"Get a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-subscription"},{"title":"Update a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json put /webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-subscription"},{"title":"Deletes a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/deletes-a-webhook-subscription"},{"title":"Notify a webhook subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/{id}/notify","href":"/api-reference/webhooks/notify-a-webhook-subscription"}]}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/docs/sdk-docs/675c9816cdaf6-getting-started"}]},{"tab":"Status","pages":[{"title":"Status","href":"/docs/platform-docs/e8rdxqzugb5zf-status"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/docs/api-docs/98439555e1d41-release-notes"}]}]},"title":"Get firm - Smokeball","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}