{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Redbark","colors":{"primary":"#FF5454","light":"#FF8A8A","dark":"#D40A20"},"logo":{"light":"https://mintcdn.com/redbark/Lg8qacPKNh5Xpue4/logo/light.png?fit=max\u0026auto=format\u0026n=Lg8qacPKNh5Xpue4\u0026q=85\u0026s=de3279ffc7bef823bfa1e593b81265d9","dark":"https://mintcdn.com/redbark/Lg8qacPKNh5Xpue4/logo/dark.png?fit=max\u0026auto=format\u0026n=Lg8qacPKNh5Xpue4\u0026q=85\u0026s=7960b0842dc00cfd472af3821d8ca953"},"favicon":"https://mintcdn.com/redbark/4quigyRAqPSbF82b/favicon.svg?fit=max\u0026auto=format\u0026n=4quigyRAqPSbF82b\u0026q=85\u0026s=9b80c48967b4ae7c425626dff0d139d2","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"navbar":{"links":[{"href":"mailto:support@redbark.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.redbark.com/sign-in"}},"footer":{"socials":{"github":"https://github.com/redbark-co"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"redbark","hasAudioNarration":false,"actualSubdomain":"redbark","customDomains":["redbark.com"],"gitSource":{"type":"github","owner":"redbark-co","repo":"core","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae7afdfd1e13879fd7dba77","collectionId":"1e4544a5-83d9-425f-9398-cf39951ad549","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae7afdfd1e13879fd7dba77"},"feedback":{"agentFeedback":true},"entitlements":{},"buildId":"6ae80a97f47be6d76b63c45d","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":228},{"language":"default","tag":"Sync","count":151},{"language":"default","tag":"Advisor","count":143},{"language":"default","tag":"Documentation","count":54},{"language":"default","tag":"Checklists","count":22},{"language":"default","tag":"Destinations","count":18},{"language":"default","tag":"Document types","count":18},{"language":"default","tag":"Documents","count":17},{"language":"default","tag":"Help center","count":16},{"language":"default","tag":"Rules","count":14}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"advisor/api-reference/firm/get-the-firm","slug":"/advisor/api-reference/firm/get-the-firm","pageMetadata":{"title":"Get the firm","description":"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /organisation","href":"/advisor/api-reference/firm/get-the-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: \"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\"\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":{"config":{},"pageMetadata":{"title":"Get the firm","description":"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /organisation","href":"/advisor/api-reference/firm/get-the-firm","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"get_organisation","summary":"Get the firm","description":"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.","security":["6f7fb9d6-339b-4322-a9f7-2ae9f7dfdc59"],"x-required-scope":"organisation:read","parameters":[],"responses":{"200":"0d0fe66f-f679-4bfa-9536-435873a63da2","400":"7e97aac1-6720-4e38-906c-eff4ec1ce5a5","401":"975c79a9-ed69-4a12-987c-4b2b4384b181","402":"768bbef0-c90f-485a-8e70-75ebe91f7ac2","403":"e533e20b-1787-467b-b089-79108c5aef24","404":"2e1a9304-523a-41f8-982d-3472207320c3","409":"d4a60f32-22e7-48b9-80d2-397006adc1c4","413":"2d11fa9b-2dd7-477f-849e-9e38308bf7f1","429":"d37abac3-57b0-4ef1-864b-1aee650d2ef4","500":"e7686b24-e0d4-4804-a298-9f9e3f633d61"},"tags":["Firm"],"method":"get","type":"path","servers":["f95e2573-3396-4dac-b7ac-d36dc90a7bf0"],"path":"/organisation","baseUrlOptions":["https://advisor.redbark.com/api/v1"],"title":"Get the firm","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"0d0fe66f-f679-4bfa-9536-435873a63da2":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","enum":["organisation"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"slug":{"type":"string","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"brand_color":{"oneOf":[{"type":"string","description":"A colour as #RRGGBB.","isRequired":true,"uniqueKey":"brand_color.oneOf.0","typeLabel":"string"},{"type":"null","description":"A colour as #RRGGBB.","isRequired":true,"uniqueKey":"brand_color.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"brand_color","typeLabel":"string | null"},"has_logo":{"type":"boolean","description":"Whether a logo is set. The image is not returned.","isRequired":true,"uniqueKey":"has_logo","typeLabel":"boolean"},"send_client_emails":{"type":"boolean","description":"Whether Advisor emails clients. Off, the firm sends its own from webhooks.","isRequired":true,"uniqueKey":"send_client_emails","typeLabel":"boolean"},"show_secured_by":{"type":"boolean","description":"Whether the portal footer says Secured by Redbark.","isRequired":true,"uniqueKey":"show_secured_by","typeLabel":"boolean"},"onboarded":{"type":"boolean","isRequired":true,"uniqueKey":"onboarded","typeLabel":"boolean"},"acting_as":{"type":"object","properties":{"member_id":{"type":"string","isRequired":true,"uniqueKey":"acting_as.member_id","typeLabel":"string"},"role":{"type":"string","enum":["admin","member"],"isRequired":true,"uniqueKey":"acting_as.role","typeLabel":"enum\u003cstring>"}},"required":["member_id","role"],"additionalProperties":true,"isRequired":true,"uniqueKey":"acting_as","typeLabel":"object"}},"required":["object","id","name","slug","brand_color","has_logo","send_client_emails","show_secured_by","onboarded","acting_as"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"organisation","id":"\u003cstring>","name":"\u003cstring>","slug":"\u003cstring>","brand_color":"\u003cstring>","has_logo":true,"send_client_emails":true,"show_secured_by":true,"onboarded":true,"acting_as":{"member_id":"\u003cstring>","role":"admin"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7e97aac1-6720-4e38-906c-eff4ec1ce5a5":{"description":"The request is not valid.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"975c79a9-ed69-4a12-987c-4b2b4384b181":{"description":"The API key or access token is missing, wrong, expired or revoked.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"768bbef0-c90f-485a-8e70-75ebe91f7ac2":{"description":"subscription_required: the firm has no active subscription, so it cannot add or invite clients or send checklists.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e533e20b-1787-467b-b089-79108c5aef24":{"description":"The credential lacks the scope this call needs, the call is for admins only, or the member it acts as has left the firm.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2e1a9304-523a-41f8-982d-3472207320c3":{"description":"No such resource in this firm.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d4a60f32-22e7-48b9-80d2-397006adc1c4":{"description":"The resource is in a state that does not allow this, such as an archived client, or client_limit_reached: the plan’s 20 active clients are in use.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"2d11fa9b-2dd7-477f-849e-9e38308bf7f1":{"description":"The request body is too large.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"d37abac3-57b0-4ef1-864b-1aee650d2ef4":{"description":"Too many requests. See the Retry-After header.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7686b24-e0d4-4804-a298-9f9e3f633d61":{"description":"Something went wrong on our side. Try again.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["invalid_request_error","authentication_error","permission_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"}},"required":["type","code","message","param","request_id"],"additionalProperties":true,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","request_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6f7fb9d6-339b-4322-a9f7-2ae9f7dfdc59":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.","scopes":["organisation:read"],"schemeName":"bearerAuth"}}},"servers":{"f95e2573-3396-4dac-b7ac-d36dc90a7bf0":{"url":"https://advisor.redbark.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.","scopes":["organisation:read"],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A firm API key, shown once when it is made, or a connected app’s OAuth access token. Each operation lists the scope it needs, such as clients:write.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/advisor.json"},"subdomain":"redbark","siteName":"Redbark","title":"Get the firm - Redbark","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T03:59:28.164Z","originalFileLocation":"advisor/api-reference/firm/get-the-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=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Redbark\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_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=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get the firm - Redbark\">\u003cmeta data-mint-head property=\"og:description\" content=\"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Redbark\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://redbark.mintlify.app/_mintlify/api/og/v2?division=Firm\u0026amp;title=Get+the+firm\u0026amp;description=The+firm+this+key+or+connection+acts+in%3A+its+name%2C+address+%28slug%29%2C+brand+colour%2C+and+the+member+and+role+the+call+acts+as.\u0026amp;theme=dab95e9f32bbdf5feb9572e8\u0026amp;signature=5e182af55d69af50e374032c21714e1651475ebc263d1ee154b02e9ca11733ff\">\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 the firm - Redbark\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://redbark.mintlify.app/_mintlify/api/og/v2?division=Firm\u0026amp;title=Get+the+firm\u0026amp;description=The+firm+this+key+or+connection+acts+in%3A+its+name%2C+address+%28slug%29%2C+brand+colour%2C+and+the+member+and+role+the+call+acts+as.\u0026amp;theme=dab95e9f32bbdf5feb9572e8\u0026amp;signature=5e182af55d69af50e374032c21714e1651475ebc263d1ee154b02e9ca11733ff\">\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=\"/docs/mintlify-assets/_mintlify/favicons/redbark/18Zou9nIgNt39LhG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Redbark\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5454\">\u003clink data-mint-head rel=\"canonical\" href=\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/advisor/api-reference/firm/get-the-firm.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://redbark.com/#organization\",\"name\":\"Redbark\",\"url\":\"https://redbark.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/redbark/Lg8qacPKNh5Xpue4/logo/light.png?fit=max\u0026auto=format\u0026n=Lg8qacPKNh5Xpue4\u0026q=85\u0026s=de3279ffc7bef823bfa1e593b81265d9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://redbark.com/docs#website\",\"name\":\"Redbark\",\"url\":\"https://redbark.com/docs\",\"publisher\":{\"@id\":\"https://redbark.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm#webpage\",\"url\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm\",\"name\":\"Get the firm\",\"description\":\"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\",\"dateModified\":\"2026-11-02T03:59:28.164Z\",\"isPartOf\":{\"@id\":\"https://redbark.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Redbark\",\"item\":\"https://redbark.com/docs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get the firm\",\"item\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm#apireference\",\"headline\":\"Get the firm\",\"name\":\"Get the firm\",\"description\":\"The firm this key or connection acts in: its name, address (slug), brand colour, and the member and role the call acts as.\",\"url\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm\",\"mainEntityOfPage\":{\"@id\":\"https://redbark.com/docs/advisor/api-reference/firm/get-the-firm#webpage\"},\"dateModified\":\"2026-11-02T03:59:28.164Z\",\"publisher\":{\"@id\":\"https://redbark.com/#organization\"},\"isPartOf\":{\"@id\":\"https://redbark.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Redbark\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Redbark","nav":{"global":null,"products":[{"product":"Sync","icon":"arrows-rotate","description":"Bank feeds to spreadsheets, budgeting apps and your own code","pages":[{"title":"Sync","href":""}]},{"product":"Advisor","icon":"briefcase","description":"Client portal for advisory firms. Closed Beta","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/advisor"}]},{"tab":"API Reference","groups":[{"group":"Guides","pages":[{"title":"API overview","tag":"Closed Beta","href":"/advisor/api-reference/overview"},{"title":"Authentication","tag":"Closed Beta","href":"/advisor/api-reference/authentication"},{"title":"Errors, limits and pagination","tag":"Closed Beta","href":"/advisor/api-reference/errors"},{"title":"Webhooks","description":"Get a signed request from Redbark Advisor when a client joins, a checklist item is submitted, a document is uploaded and more.","tag":"Closed Beta","href":"/advisor/api-reference/webhooks"}]},{"group":"Firm","pages":[{"title":"Get the firm","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /organisation","href":"/advisor/api-reference/firm/get-the-firm"},{"title":"Change the firm","description":"Changes the firm name, brand colour or logo, and whether Advisor emails clients and shows Secured by Redbark in the portal. Send only the fields to change. The logo is a data URL of a PNG, JPEG or WebP image of 1 MB or less, or null to remove it. Only an admin can call this.","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /organisation","href":"/advisor/api-reference/firm/change-the-firm"}]},{"group":"Team","pages":[{"title":"List members","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /members","href":"/advisor/api-reference/team/list-members"},{"title":"Invite members","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /members/invitations","href":"/advisor/api-reference/team/invite-members"},{"title":"List open invitations","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /members/invitations","href":"/advisor/api-reference/team/list-open-invitations"},{"title":"Change a member’s role","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /members/{member}","href":"/advisor/api-reference/team/change-a-member’s-role"},{"title":"Remove a member","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /members/{member}","href":"/advisor/api-reference/team/remove-a-member"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /members/invitations/revoke","href":"/advisor/api-reference/team/revoke-an-invitation"},{"title":"Resend an invitation","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /members/invitations/resend","href":"/advisor/api-reference/team/resend-an-invitation"}]},{"group":"Clients","pages":[{"title":"List clients","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients","href":"/advisor/api-reference/clients/list-clients"},{"title":"Add a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients","href":"/advisor/api-reference/clients/add-a-client"},{"title":"Get a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}","href":"/advisor/api-reference/clients/get-a-client"},{"title":"Change a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /clients/{client}","href":"/advisor/api-reference/clients/change-a-client"},{"title":"Invite a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/invite","href":"/advisor/api-reference/clients/invite-a-client"},{"title":"Resend a client invite","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/invite/resend","href":"/advisor/api-reference/clients/resend-a-client-invite"},{"title":"Make a client invite link","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/invite/link","href":"/advisor/api-reference/clients/make-a-client-invite-link"},{"title":"Archive a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/archive","href":"/advisor/api-reference/clients/archive-a-client"}]},{"group":"Checklists","pages":[{"title":"List checklist templates","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /checklist_templates","href":"/advisor/api-reference/checklists/list-checklist-templates"},{"title":"Create a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /checklist_templates","href":"/advisor/api-reference/checklists/create-a-checklist-template"},{"title":"Get a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /checklist_templates/{template}","href":"/advisor/api-reference/checklists/get-a-checklist-template"},{"title":"Rename a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /checklist_templates/{template}","href":"/advisor/api-reference/checklists/rename-a-checklist-template"},{"title":"Delete a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /checklist_templates/{template}","href":"/advisor/api-reference/checklists/delete-a-checklist-template"},{"title":"Duplicate a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /checklist_templates/{template}/duplicate","href":"/advisor/api-reference/checklists/duplicate-a-checklist-template"},{"title":"Add an item to a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /checklist_templates/{template}/items","href":"/advisor/api-reference/checklists/add-an-item-to-a-checklist-template"},{"title":"Change a checklist template item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /checklist_template_items/{item}","href":"/advisor/api-reference/checklists/change-a-checklist-template-item"},{"title":"Remove a checklist template item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /checklist_template_items/{item}","href":"/advisor/api-reference/checklists/remove-a-checklist-template-item"},{"title":"Duplicate a checklist template item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /checklist_template_items/{item}/duplicate","href":"/advisor/api-reference/checklists/duplicate-a-checklist-template-item"},{"title":"Reorder a checklist template","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /checklist_templates/{template}/items/reorder","href":"/advisor/api-reference/checklists/reorder-a-checklist-template"},{"title":"List a client’s checklists","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/checklists","href":"/advisor/api-reference/checklists/list-a-client’s-checklists"},{"title":"Send a checklist to a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/checklists","href":"/advisor/api-reference/checklists/send-a-checklist-to-a-client"},{"title":"Get a client’s checklist","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/checklists/{checklist}","href":"/advisor/api-reference/checklists/get-a-client’s-checklist"},{"title":"Rename a client’s checklist","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /clients/{client}/checklists/{checklist}","href":"/advisor/api-reference/checklists/rename-a-client’s-checklist"},{"title":"Remove a client’s checklist","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /clients/{client}/checklists/{checklist}","href":"/advisor/api-reference/checklists/remove-a-client’s-checklist"},{"title":"Add an item to a client’s checklist","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/checklists/{checklist}/items","href":"/advisor/api-reference/checklists/add-an-item-to-a-client’s-checklist"},{"title":"Change a client’s checklist item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /clients/{client}/checklist_items/{item}","href":"/advisor/api-reference/checklists/change-a-client’s-checklist-item"},{"title":"Remove a client’s checklist item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /clients/{client}/checklist_items/{item}","href":"/advisor/api-reference/checklists/remove-a-client’s-checklist-item"},{"title":"Reorder a client’s checklist","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/checklists/{checklist}/items/reorder","href":"/advisor/api-reference/checklists/reorder-a-client’s-checklist"},{"title":"Approve a checklist item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/checklist_items/{item}/approve","href":"/advisor/api-reference/checklists/approve-a-checklist-item"},{"title":"Request changes on a checklist item","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/checklist_items/{item}/request_changes","href":"/advisor/api-reference/checklists/request-changes-on-a-checklist-item"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/documents","href":"/advisor/api-reference/documents/list-documents"},{"title":"Get a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/documents/{document}","href":"/advisor/api-reference/documents/get-a-document"},{"title":"Delete a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /clients/{client}/documents/{document}","href":"/advisor/api-reference/documents/delete-a-document"},{"title":"Start a document upload","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/uploads","href":"/advisor/api-reference/documents/start-a-document-upload"},{"title":"Download a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/download","href":"/advisor/api-reference/documents/download-a-document"},{"title":"List facts","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/facts","href":"/advisor/api-reference/documents/list-facts"},{"title":"Accept a fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/facts/{fact}/accept","href":"/advisor/api-reference/documents/accept-a-fact"},{"title":"Reject a fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/facts/{fact}/reject","href":"/advisor/api-reference/documents/reject-a-fact"},{"title":"List a document’s values","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/documents/{document}/values","href":"/advisor/api-reference/documents/list-a-document’s-values"},{"title":"Approve a document value","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/document_values/{document_value}/approve","href":"/advisor/api-reference/documents/approve-a-document-value"},{"title":"Undo a document value","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/document_values/{document_value}/undo","href":"/advisor/api-reference/documents/undo-a-document-value"},{"title":"Approve a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/approve","href":"/advisor/api-reference/documents/approve-a-document"},{"title":"Reopen a document review","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/reopen","href":"/advisor/api-reference/documents/reopen-a-document-review"},{"title":"Read a document as a type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/read_as","href":"/advisor/api-reference/documents/read-a-document-as-a-type"},{"title":"Keep a document as a file only","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/keep_as_file","href":"/advisor/api-reference/documents/keep-a-document-as-a-file-only"},{"title":"Send a document back to the client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/documents/{document}/send_back","href":"/advisor/api-reference/documents/send-a-document-back-to-the-client"},{"title":"Get a suggested document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /document_type_suggestions/{suggestion}","href":"/advisor/api-reference/documents/get-a-suggested-document-type"}]},{"group":"Money","pages":[{"title":"Get a money summary","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/money","href":"/advisor/api-reference/money/get-a-money-summary"},{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/accounts","href":"/advisor/api-reference/money/list-accounts"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/accounts/{account}","href":"/advisor/api-reference/money/get-an-account"},{"title":"Change a document account","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /clients/{client}/accounts/{account}","href":"/advisor/api-reference/money/change-a-document-account"},{"title":"Accept a balance","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/balances/{balance}/accept","href":"/advisor/api-reference/money/accept-a-balance"},{"title":"Reject a balance","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/balances/{balance}/reject","href":"/advisor/api-reference/money/reject-a-balance"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/transactions","href":"/advisor/api-reference/money/list-transactions"},{"title":"List bank connections","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/connections","href":"/advisor/api-reference/money/list-bank-connections"},{"title":"Refresh a bank connection","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/connections/{connection}/refresh","href":"/advisor/api-reference/money/refresh-a-bank-connection"},{"title":"Disconnect a bank","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/connections/{connection}/disconnect","href":"/advisor/api-reference/money/disconnect-a-bank"}]},{"group":"Document types","pages":[{"title":"List document types","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /document_types","href":"/advisor/api-reference/document-types/list-document-types"},{"title":"Make a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types","href":"/advisor/api-reference/document-types/make-a-document-type"},{"title":"Get a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /document_types/{type}","href":"/advisor/api-reference/document-types/get-a-document-type"},{"title":"Change a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /document_types/{type}","href":"/advisor/api-reference/document-types/change-a-document-type"},{"title":"Archive a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/archive","href":"/advisor/api-reference/document-types/archive-a-document-type"},{"title":"Restore a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/restore","href":"/advisor/api-reference/document-types/restore-a-document-type"},{"title":"Count unplaced documents","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /unplaced_documents/count","href":"/advisor/api-reference/document-types/count-unplaced-documents"},{"title":"Suggest a type for a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_type_suggestions","href":"/advisor/api-reference/document-types/suggest-a-type-for-a-document"},{"title":"Add a field to a document type","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/fields","href":"/advisor/api-reference/document-types/add-a-field-to-a-document-type"},{"title":"Change a document type field","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /document_types/{type}/fields/{field}","href":"/advisor/api-reference/document-types/change-a-document-type-field"},{"title":"Archive a document type field","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/fields/{field}/archive","href":"/advisor/api-reference/document-types/archive-a-document-type-field"},{"title":"Restore a document type field","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/fields/{field}/restore","href":"/advisor/api-reference/document-types/restore-a-document-type-field"},{"title":"Reorder document type fields","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /document_types/{type}/fields/reorder","href":"/advisor/api-reference/document-types/reorder-document-type-fields"},{"title":"List fact definitions","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /fact_definitions","href":"/advisor/api-reference/document-types/list-fact-definitions"},{"title":"Make a client fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /fact_definitions","href":"/advisor/api-reference/document-types/make-a-client-fact"},{"title":"Rename a client fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /fact_definitions/{fact}","href":"/advisor/api-reference/document-types/rename-a-client-fact"},{"title":"Archive a client fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /fact_definitions/{fact}/archive","href":"/advisor/api-reference/document-types/archive-a-client-fact"},{"title":"Restore a client fact","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /fact_definitions/{fact}/restore","href":"/advisor/api-reference/document-types/restore-a-client-fact"}]},{"group":"Messages","pages":[{"title":"List message threads","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /threads","href":"/advisor/api-reference/messages/list-message-threads"},{"title":"List a client’s messages","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/messages","href":"/advisor/api-reference/messages/list-a-client’s-messages"},{"title":"Message a client","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/messages","href":"/advisor/api-reference/messages/message-a-client"},{"title":"List the comments on a document","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /clients/{client}/documents/{document}/comments","href":"/advisor/api-reference/messages/list-the-comments-on-a-document"},{"title":"Edit a message","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /clients/{client}/messages/{message}","href":"/advisor/api-reference/messages/edit-a-message"},{"title":"Delete a message","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /clients/{client}/messages/{message}","href":"/advisor/api-reference/messages/delete-a-message"},{"title":"Mark a thread read","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /clients/{client}/messages/read","href":"/advisor/api-reference/messages/mark-a-thread-read"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /reports","href":"/advisor/api-reference/reports/list-reports"},{"title":"Export a report","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /reports","href":"/advisor/api-reference/reports/export-a-report"},{"title":"Get a report","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /reports/{report}","href":"/advisor/api-reference/reports/get-a-report"},{"title":"Delete a report","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /reports/{report}","href":"/advisor/api-reference/reports/delete-a-report"}]},{"group":"Webhooks","pages":[{"title":"List event types","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /event-types","href":"/advisor/api-reference/webhooks/list-event-types"},{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /webhook-endpoints","href":"/advisor/api-reference/webhooks/list-webhook-endpoints"},{"title":"Add a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /webhook-endpoints","href":"/advisor/api-reference/webhooks/add-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /webhook-endpoints/{endpoint}","href":"/advisor/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Change a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/advisor.json patch /webhook-endpoints/{endpoint}","href":"/advisor/api-reference/webhooks/change-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/advisor.json delete /webhook-endpoints/{endpoint}","href":"/advisor/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Roll a webhook secret","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /webhook-endpoints/{endpoint}/roll-secret","href":"/advisor/api-reference/webhooks/roll-a-webhook-secret"},{"title":"List webhook deliveries","deprecated":null,"version":null,"openapi":"/openapi/advisor.json get /webhook-endpoints/{endpoint}/deliveries","href":"/advisor/api-reference/webhooks/list-webhook-deliveries"},{"title":"Resend a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /webhook-deliveries/{delivery}/resend","href":"/advisor/api-reference/webhooks/resend-a-webhook-delivery"},{"title":"Send a test webhook","deprecated":null,"version":null,"openapi":"/openapi/advisor.json post /webhook-endpoints/{endpoint}/test","href":"/advisor/api-reference/webhooks/send-a-test-webhook"}]},{"group":"Webhook events","pages":[{"title":"Clientcreated","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook client.created","href":"/advisor/api-reference/webhook-events/clientcreated"},{"title":"Clientinvited","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook client.invited","href":"/advisor/api-reference/webhook-events/clientinvited"},{"title":"Clientjoined","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook client.joined","href":"/advisor/api-reference/webhook-events/clientjoined"},{"title":"Checklistsent","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook checklist.sent","href":"/advisor/api-reference/webhook-events/checklistsent"},{"title":"Checklistitem submitted","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook checklist.item_submitted","href":"/advisor/api-reference/webhook-events/checklistitem_submitted"},{"title":"Checklistitem changes requested","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook checklist.item_changes_requested","href":"/advisor/api-reference/webhook-events/checklistitem_changes_requested"},{"title":"Checklistcompleted","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook checklist.completed","href":"/advisor/api-reference/webhook-events/checklistcompleted"},{"title":"Documentuploaded","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook document.uploaded","href":"/advisor/api-reference/webhook-events/documentuploaded"},{"title":"Factaccepted","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook fact.accepted","href":"/advisor/api-reference/webhook-events/factaccepted"},{"title":"Accountconnected","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook account.connected","href":"/advisor/api-reference/webhook-events/accountconnected"},{"title":"Accountdisconnected","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook account.disconnected","href":"/advisor/api-reference/webhook-events/accountdisconnected"},{"title":"Messagecreated","version":null,"deprecated":null,"openapi":"/openapi/advisor.json webhook message.created","href":"/advisor/api-reference/webhook-events/messagecreated"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/advisor/mcp"}]}]}]},"basePath":"","title":"Get the firm - Redbark","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CLz2_Z5D.js","utils-7A5jZhOT.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BVWmkKuv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-4SOfrh0F.js","snippetPresets-CMc8KicP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ba9tX7z3.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Be8krXvv.js","shallow-CBC3K1uB.js","getApiPlaygroundDisplay-4tKcUAYo.js","CodeSnippet-C1Xa06ft.js","CodeSnippets-vqiz27A_.js","Page-DeQN5MDd.js","getPastedJson-NUwRfM32.js","icon-DkIVqWh9.js","MethodPill-qmhT7_wz.js","DuplicateIcon-_gWp1vhn.js","createIcon-NA1p_TVA.js","DynamicMarkdown-Bas9A7wq.js","SectionHeading-a1cS-24U.js","axios-vUo_bRtp.js","Markdown-D3ZTwq_a.js","clsx-BcghKhHb.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B66mVNPp.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DmooSyTN.js"]}