IsDefault indicates whether this Hub is the default Hub for the organisation. Only one Hub can be the default
Hub for an organisation.
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Versori User Documentation","colors":{"primary":"#6EB0D8","light":"#6EB0D8","dark":"#6EB0D8"},"logo":{"light":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af","dark":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1568a99dadb6fa8dfc83009eba877497"},"favicon":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1765cb3e4363526dd85cf7c576a8f68f","api":{"openapi":["openapi/connect-api-v1.yaml","openapi/embedded-api-v1.yaml","openapi/organisations-api-v1.yaml","openapi/switchboard-api-v1alpha1.yaml","openapi/platform-api.yaml"],"playground":{"display":"interactive","proxy":false},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://platform.versori.com/api"]}},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#151919"}},"search":{"prompt":"Search the docs..."},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"versori","hasAudioNarration":false,"actualSubdomain":"versori","customDomains":["docs.versori.com"],"gitSource":{"type":"github","owner":"versori","repo":"user-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad09d9413e5d952c6a7407c","collectionId":"314b2d25-0631-41c2-aeae-fdf8104d942c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad09d9413e5d952c6a7407c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad09d9413e5d952c6a7407c","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":525},{"language":"default","tag":"Platform API","count":115},{"language":"default","tag":"Switchboard API","count":82},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"Connect API","count":41},{"language":"default","tag":"Organisations API","count":38},{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"projects","count":32},{"language":"default","tag":"User Guide","count":31},{"language":"default","tag":"CLI","count":27}]},"assistantConfig":{},"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":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area.max-w-xl{max-width:64rem}.whitespace-pre-line{white-space:unset}"}],"page":{"pagePath":"legacy/api-reference/embedded-api/hubs/retrieve-a-hub","slug":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub","pageMetadata":{"openapi":"get /hubs/{hub_id}","title":"Retrieve a Hub","description":"GetHub returns the Hub for the given ID.\n","href":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub"},"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: \"GetHub returns the Hub for the given ID.\"\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":{"openapi":"get /hubs/{hub_id}","title":"Retrieve a Hub","description":"GetHub returns the Hub for the given ID.\n","href":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"GetHub","summary":"Retrieve a Hub","description":"GetHub returns the Hub for the given ID.\n","tags":["Hubs"],"responses":{"200":"572b2a91-d244-44bb-91c2-493bb833e73c","default":"1ef8ec63-f9f0-46af-a7ba-a6d8294da945"},"method":"get","type":"path","servers":["662036c2-097e-4f5a-88fa-262b3a3c9120","a0760f0f-7ce5-4f74-8ab0-ca1b64ebe4f7","b811851b-92c2-4bbe-a9ef-52523f52d451"],"security":[],"path":"/hubs/{hub_id}","baseUrlOptions":["https://platform.versori.com/api/embedded/v1","https://platform-staging.versori.com/api/embedded/v1/","http://localhost:8950/embedded/v1"],"title":"Retrieve a Hub","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"93c88ef6-43ae-45ff-8f64-a7eaff70efdd":{"name":"hub_id","in":"path","required":true,"schema":{"type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-type-skip-optional-pointer":true,"x-go-type-import":{"path":"versori.dev/vergo/ulid"},"isRequired":true,"uniqueKey":"","typeLabel":"string\u003culid>"}}},"responses":{"572b2a91-d244-44bb-91c2-493bb833e73c":{"description":"OK","content":{"application/json":{"schema":{"description":"A Hub description","type":"object","properties":{"id":{"description":"The ID of the Hub","type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-type-skip-optional-pointer":true,"x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-name":"ID","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003culid>"},"name":{"description":"The name of the Hub","type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"primaryConnector":{"description":"PrimaryConnector is the connector that the Hub is built around.\n","type":"object","properties":{"connectorId":{"description":"ID is the unique identifier of the Hub Connector.","type":"string","format":"ulid","x-go-type":"ulid.ULID","x-go-type-skip-optional-pointer":true,"x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-name":"ConnectorID","isRequired":true,"uniqueKey":"primaryConnector.connectorId","typeLabel":"string\u003culid>"},"name":{"description":"name denotes the name of the Connector that the template is wrapping.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.name","typeLabel":"string"},"authSchemeConfig":{"oneOf":[{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.description","typeLabel":"string"},"schemeType":{"type":"string","const":"none","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.schemeType","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.0","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","name","in","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.description","typeLabel":"string"},"schemeType":{"type":"string","const":"api-key","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.schemeType","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the API key.","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigAPIKeyIn defines the location of the API key in the request.\n","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.in","typeLabel":"enum\u003cstring>"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.1","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.description","typeLabel":"string"},"schemeType":{"type":"string","const":"basic-auth","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.schemeType","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.2","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","authorizeUrl","tokenUrl","scopes","defaultScopes","grant","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.description","typeLabel":"string"},"schemeType":{"type":"string","const":"oauth2","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.schemeType","typeLabel":"string"},"authorizeUrl":{"type":"string","format":"uri","description":"AuthorizeURL is the URL which the user will be redirected to in order to authorize \nthe application.\n","x-go-name":"AuthorizeURL","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.authorizeUrl","typeLabel":"string\u003curi>"},"tokenUrl":{"type":"string","format":"uri","description":"TokenURL is the URL which the application will use to issue an access token.\n","x-go-name":"TokenURL","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.tokenUrl","typeLabel":"string\u003curi>"},"scopes":{"description":"Scopes is the list of all OAuth2 scopes which the application supports. The user \nwill be allowed to choose which scopes to request when configuring the Connection.\n","type":"array","items":{"description":"OAuth2Scope represents a single scope which can be requested by an OAuth2 application.\n","type":"object","properties":{"name":{"type":"string","description":"Name is the name of the scope as determined by the application to which this Connector \nis connecting to.\n","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.scopes.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Description describes the scope in human-friendly terminology. This text may be \ndisplayed to users via a help tooltip or similar.\n","x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.scopes.items.[INDEX].description","typeLabel":"string"}},"required":["name"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.scopes.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.scopes","typeLabel":"object[]"},"defaultScopes":{"description":"DefaultScopes is the list of scopes which will be requested by default when the user\nconnects the Connector. This is useful for Connectors which require a specific set \nof scopes to function correctly.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.defaultScopes.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.defaultScopes","typeLabel":"string[]"},"grant":{"oneOf":[{"type":"object","description":"AuthSchemeConfigOAuth2GrantAuthorizationCode contains grant-specific configuration for the \n`authorization_code` grant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is updated in the database. \n- Otherwise, both the credential and the database are updated using JSON Merge Patch, with\n undefined properties not being updated.\n- Any other permutation will result in a 400 Bad Request.\n","required":["grantType"],"properties":{"grantType":{"type":"string","const":"authorization_code","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0.grantType","typeLabel":"string"},"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","type":"string","format":"ulid","x-go-name":"CredentialID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential. \nThis can be different to the Connector's OrganisationID since some may be imported from \nVersori's public library.\n","type":"string","format":"ulid","x-go-name":"OrganisationID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be \npresented to the user in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be\ndisplayed to the user.\n","type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.0","typeLabel":"object"},{"type":"object","required":["grantType"],"properties":{"grantType":{"type":"string","const":"client_credentials","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.1.grantType","typeLabel":"string"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.1","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfigOAuth2GrantPassword contains grant-specific configuration for the `password` \ngrant type.\n\nHow the API manages changes to this configuration is as follows:\n\n- CredentialID and OrganisationID are not set, a new credential is created containing the\n sensitive information and the non-sensitive information is created/updated in the \n database. \n- Otherwise, both the credential and the database are updated using JSON Merge Patch.\n- Any other permutation will result in a 400 Bad Request.\n","required":["grantType"],"properties":{"grantType":{"type":"string","const":"password","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2.grantType","typeLabel":"string"},"credentialId":{"description":"CredentialID is the unique identifier of the Credential which contains the client ID and\nclient secret to be used as part of the `password` flow.\n","type":"string","format":"ulid","x-go-name":"CredentialID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2.credentialId","typeLabel":"string\u003culid>"},"organisationId":{"description":"OrganisationID is the unique identifier of the Organisation that owns the Credential. This can be different\nto the Connector's OrganisationID since some may be imported from Versori's public library.\n","type":"string","format":"ulid","x-go-name":"OrganisationID","x-go-type":"ulid.ULID","x-go-type-import":{"path":"versori.dev/vergo/ulid"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2.organisationId","typeLabel":"string\u003culid>"},"clientId":{"description":"ClientID is the OAuth 2.0 client's identifier. This is not a sensitive value and may be presented to the \nuser in plaintext.\n","type":"string","x-go-name":"ClientID","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2.clientId","typeLabel":"string"},"clientSecret":{"description":"ClientSecret is the OAuth 2.0 client's secret. This is a sensitive value and will not be displayed to the \nuser. It may be populated when updating the Credential.\n","type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2.clientSecret","typeLabel":"string"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant.oneOf.2","typeLabel":"object"}],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.grant","typeLabel":"object"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.validationMessages","typeLabel":"object[]"},"additionalAuthorizeParams":{"description":"AdditionalAuthorizeParams is a URL-encoded query string which should be attached to \nthe AuthorizeURL when the user is redirected to the OAuth 2.0 authorization \nendpoint.\n\nThis value is only used by the UI to drive the default values when connecting, the \nAPI to `InitialiseOAuth2Connection` can be provided a different value if required.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.additionalAuthorizeParams","typeLabel":"string"},"additionalTokenParams":{"description":"AdditionalTokenParams is a URL-encoded string following the \n`application/x-www-form-urlencoded` mime-type, which can be used to pass additional\nparameters to the OAuth 2.0 token endpoint within the request body.\n","type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.additionalTokenParams","typeLabel":"string"},"mtlsEnabled":{"type":"boolean","description":"MTLSEnabled is a flag which determines whether the Connector should use Mutual TLS \n(mTLS) to authenticate with the OAuth 2.0 token endpoint. This is useful for \nConnectors which require a higher level of security.\n","x-go-name":"MTLSEnabled","x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.mtlsEnabled","typeLabel":"boolean"},"mtlsCredentialId":{"type":"string","description":"MTLSCredentialID is the unique identifier of the Credential which contains the \nclient certificate and private key to be used as part of the mTLS connection. \n\nThis may be unset when creating a connection, in which case if `mtlsEnabled` is \ntrue, then the API will find an associated AuthSchemeConfigCertificate and link \nthem automatically.\n","x-go-name":"MTLSCredentialID","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3.mtlsCredentialId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.3","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","name","in","algorithm","digestInputs","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.description","typeLabel":"string"},"schemeType":{"type":"string","const":"hmac","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.schemeType","typeLabel":"string"},"name":{"type":"string","description":"Name is the query parameter/header/cookie name which will be used to send the signature.","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.name","typeLabel":"string"},"in":{"description":"AuthSchemeConfigHMACIn defines where the signature should be set on requests.","type":"string","enum":["query","header","cookie"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.in","typeLabel":"enum\u003cstring>"},"algorithm":{"description":"AuthSchemeConfigHMACAlgorithm defines the hashing algorithm to use when generating the HMAC signature.","type":"string","enum":["sha1","sha256","sha512"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.algorithm","typeLabel":"enum\u003cstring>"},"digestInputs":{"description":"AuthSchemeConfigHMACInputs defines what parts of a HTTP request are consumed to generate the HMAC signature. Some systems\nonly generate the signature from the request body, others may include the URL. The order of this array\ndefines the order in which the input is fed into the hashing function.\n","type":"array","items":{"type":"string","enum":["body","url"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.digestInputs.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.digestInputs","typeLabel":"enum\u003cstring>[]"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.4","typeLabel":"object"},{"type":"object","description":"AuthSchemeConfig defines how a Connector implements the AuthScheme in order to fulfil its \nauthentication requirements. This is purely the configuration and not the actual credential \nwhich is used to authenticate. The credential uses this configuration to determine how to \nauthenticate.\n","required":["schemeType","id","description"],"properties":{"id":{"type":"string","format":"ulid","description":"ID is the unique identifier of the AuthSchemeConfig, this is generated by the client and\nonly requires to be unique amongst the elements of the array in which is it contained.\n","x-go-name":"ID","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.id","typeLabel":"string\u003culid>"},"description":{"description":"Description enables users to distinguish multiple configurations which use the same \nschemeType.\n","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.description","typeLabel":"string"},"schemeType":{"type":"string","const":"certificate","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.schemeType","typeLabel":"string"},"validationMessages":{"description":"ValidationMessages is a list of messages which are generated when the AuthSchemeConfig \nis validated. This is typically used to provide feedback to the user when they are \ncreating or updating the AuthSchemeConfig.\n\nThis field will be ignored if sent to the API.\n","type":"array","items":{"description":"Message is a message to be displayed to the user to indicate some information about the\npreceding request.\n","type":"object","properties":{"text":{"description":"Text contains the text of the message.","type":"string","isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].text","typeLabel":"string"},"severity":{"type":"string","enum":["info","warning","error"],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].severity","typeLabel":"enum\u003cstring>"},"detail":{"description":"Details contains additional information about the message. This is intended to be used\nto provide more information about the message, such as a list of validation errors.\n","type":"array","items":{"type":"string","uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail.items.[INDEX]","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages.items.[INDEX].detail","typeLabel":"string[]"}},"required":["text","severity"],"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5.validationMessages","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig.oneOf.5","typeLabel":"object"}],"isRequired":true,"uniqueKey":"primaryConnector.authSchemeConfig","typeLabel":"object"},"imageUrl":{"description":"ImageURL is a URL to an image/icon that represents the integration. This image is used within the integration\ntile displayed in the embedded UI.\n","type":"string","format":"uri","x-go-name":"ImageURL","isRequired":true,"uniqueKey":"primaryConnector.imageUrl","typeLabel":"string\u003curi>"},"variables":{"description":"Variables is a list of Name and Value pairs that are scoped to each connection. These variables can be used to\nmutate the URL of the connector. For example if End Users connect to a service and each user has their own\ninstance of that service which is hosted at a different URL, the user can provide the URL as a variable.\n","type":"array","items":{"description":"ConnectionVariable denotes an arbitrary key/value pair which can be used to configure a connector.","type":"object","properties":{"name":{"type":"string","description":"Name is the name of the connection variable.","isRequired":true,"uniqueKey":"primaryConnector.variables.items.[INDEX].name","typeLabel":"string"},"value":{"type":"string","description":"Value is the value of the connection variable.","isRequired":true,"uniqueKey":"primaryConnector.variables.items.[INDEX].value","typeLabel":"string"}},"required":["name","value"],"uniqueKey":"primaryConnector.variables.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"primaryConnector.variables","typeLabel":"object[]"}},"required":["connectorId","name","imageUrl","variables","authSchemeConfig"],"isRequired":true,"uniqueKey":"primaryConnector","typeLabel":"object"},"isDefault":{"description":"IsDefault indicates whether this Hub is the default Hub for the organisation. Only one Hub can be the default\nHub for an organisation.\n","type":"boolean","isRequired":true,"uniqueKey":"isDefault","typeLabel":"boolean"}},"required":["id","name","primaryConnector","isDefault"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","primaryConnector":{"connectorId":"\u003cstring>","name":"\u003cstring>","authSchemeConfig":{"id":"\u003cstring>","description":"\u003cstring>","schemeType":"none","validationMessages":[{"text":"\u003cstring>","severity":"info","detail":["\u003cstring>"]}]},"imageUrl":"\u003cstring>","variables":[{"name":"\u003cstring>","value":"\u003cstring>"}]},"isDefault":true}}},"exampleType":"generated"}},"exampleType":"generated"},"1ef8ec63-f9f0-46af-a7ba-a6d8294da945":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Code is a machine-readable error code.","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Message is a human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"fields":{"type":"array","items":{"description":"ErrorField denotes a field which has an error.","type":"object","properties":{"field":{"type":"string","description":"Field is the name of the field which has an error, this may be a path to a nested field, including array\nelements. The format of this field is of the form: \"field1.field2[0].field3\"\n","isRequired":true,"uniqueKey":"fields.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Message is the error message for this specific field.","isRequired":true,"uniqueKey":"fields.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"fields.items.[INDEX]","typeLabel":"object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"fields","typeLabel":"object[]"},"details":{"type":"string","x-go-type-skip-optional-pointer":true,"uniqueKey":"details","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","fields":[{"field":"\u003cstring>","message":"\u003cstring>"}],"details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f5d583fd-8480-4dde-8010-d633ba09fc33":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."}}},"servers":{"662036c2-097e-4f5a-88fa-262b3a3c9120":{"description":"Production","url":"https://platform.versori.com/api/embedded/v1"},"a0760f0f-7ce5-4f74-8ab0-ca1b64ebe4f7":{"description":"Staging","url":"https://platform-staging.versori.com/api/embedded/v1/"},"b811851b-92c2-4bbe-a9ef-52523f52d451":{"description":"Development","url":"http://localhost:8950/embedded/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token."},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi/embedded-api-v1.yaml"},"subdomain":"versori","siteName":"Versori User Documentation","title":"Retrieve a Hub - Versori User Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/latest/home","matchLevel":4},"Legacy":{"href":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub","matchLevel":0},"v2":{"href":"/v2/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T11:43:55.908Z","originalFileLocation":"legacy/api-reference/embedded-api/hubs/retrieve-a-hub.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=\"GetHub returns the Hub for the given ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_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/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a Hub - Versori User Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"GetHub returns the Hub for the given ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Hubs\u0026amp;title=Retrieve+a+Hub\u0026amp;description=GetHub+returns+the+Hub+for+the+given+ID.%0A\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=72b154e718b65ce546940dab46a8c05f269cc46fb31691c5953cb8db80d14248\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a Hub - Versori User Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"GetHub returns the Hub for the given ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Hubs\u0026amp;title=Retrieve+a+Hub\u0026amp;description=GetHub+returns+the+Hub+for+the+given+ID.%0A\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=72b154e718b65ce546940dab46a8c05f269cc46fb31691c5953cb8db80d14248\">\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/versori/JHvcKEOb4limbJz2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6EB0D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.versori.com/#organization\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.versori.com#website\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub#webpage\",\"url\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub\",\"name\":\"Retrieve a Hub\",\"description\":\"GetHub returns the Hub for the given ID.\",\"dateModified\":\"2026-01-23T11:43:55.908Z\",\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/list-hubs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Hubs\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/list-hubs\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a Hub\",\"item\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub#apireference\",\"headline\":\"Retrieve a Hub\",\"name\":\"Retrieve a Hub\",\"description\":\"GetHub returns the Hub for the given ID.\",\"url\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub\",\"mainEntityOfPage\":{\"@id\":\"https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub#webpage\"},\"dateModified\":\"2026-01-23T11:43:55.908Z\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Versori User Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Versori User Documentation","nav":{"global":null,"versions":[{"version":"Latest","pages":[{"title":"Latest","href":"/latest/home"}]},{"version":"Legacy","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/legacy/welcome"}]},{"tab":"Integrate","pages":[{"title":"Integrate","href":"/legacy/integrate/intro"}]},{"tab":"Embedded","pages":[{"title":"Embedded","href":"/legacy/embedded/intro"}]},{"tab":"Switchboard (old)","pages":[{"title":"Switchboard (old)","href":"/legacy/switchboard/introduction"}]},{"tab":"API Reference","anchors":[{"anchor":"Authentication","pages":[{"title":"Authentication","href":"/legacy/api-reference/authentication"}]},{"anchor":"Connect API","pages":[{"title":"Connect API","href":"/legacy/api-reference/connect"}]},{"anchor":"Embedded API","pages":[{"title":"Introduction","href":"/legacy/api-reference/embedded"},{"group":"Endpoints","pages":[{"group":"Hubs","pages":[{"openapi":"get /o/{organisation_id}/hubs","title":"List Hubs","href":"/legacy/api-reference/embedded-api/hubs/list-hubs"},{"openapi":"post /hubs","title":"Create a new Hub","description":"Create a new Hub","href":"/legacy/api-reference/embedded-api/hubs/create-a-new-hub"},{"openapi":"get /hubs/{hub_id}","title":"Retrieve a Hub","href":"/legacy/api-reference/embedded-api/hubs/retrieve-a-hub"},{"openapi":"post /hubs/{hub_id}/integrations","title":"Create Integration","description":"Create Integration","href":"/legacy/api-reference/embedded-api/hubs/create-integration"},{"openapi":"patch /integrations/{integration_id}","title":"Update integration information","href":"/legacy/api-reference/embedded-api/hubs/update-integration-information"}]},{"group":"End Users","pages":[{"openapi":"get /hubs/{hub_id}/users","title":"List End Users","href":"/legacy/api-reference/embedded-api/end-users/list-end-users"},{"openapi":"post /hubs/{hub_id}/users","title":"Create an End User","href":"/legacy/api-reference/embedded-api/end-users/create-an-end-user"},{"openapi":"get /hubs/{hub_id}/users/{user_id}","title":"Retrieve an End User","href":"/legacy/api-reference/embedded-api/end-users/retrieve-an-end-user"}]},{"group":"Connections","pages":[{"openapi":"get /hubs/{hub_id}/users/{user_id}/connections","title":"List End User Connections","href":"/legacy/api-reference/embedded-api/connections/list-end-user-connections"},{"openapi":"post /hubs/{hub_id}/users/{user_id}/connections","title":"Create End User Connection","href":"/legacy/api-reference/embedded-api/connections/create-end-user-connection"},{"openapi":"post /embed/{hub_id}/connector/{connector_id}/oauth2/initialise","title":"Initialise OAuth 2.0 Connection","href":"/legacy/api-reference/embedded-api/connections/initialise-oauth-20-connection"}]},{"group":"Integrations","pages":[{"openapi":"get /hubs/{hub_id}/integrations","title":"List Integrations","href":"/legacy/api-reference/embedded-api/integrations/list-integrations"},{"openapi":"delete /integrations/{integration_id}","title":"Delete an integration.","href":"/legacy/api-reference/embedded-api/integrations/delete-an-integration"}]},{"group":"Connectors","pages":[{"openapi":"get /integrations/{integration_id}/connection-templates","title":"List Hub Connectors","href":"/legacy/api-reference/embedded-api/connectors/list-hub-connectors"},{"openapi":"post /integrations/{integration_id}/connection-templates","title":"Create a Hub Connector","href":"/legacy/api-reference/embedded-api/connectors/create-a-hub-connector"}]},{"group":"Embed","pages":[{"openapi":"get /embed/{hub_id}/users/{user_id}/integrations","title":"List End User Integrations","href":"/legacy/api-reference/embedded-api/embedded/list-end-user-integrations"},{"openapi":"get /embed/{hub_id}/users/{user_id}/integrations/{integration_id}","title":"Retrieve an Embedded Integration","href":"/legacy/api-reference/embedded-api/embedded/retrieve-an-embedded-integration"},{"openapi":"get /embed/{hub_id}/users/{user_id}/activations","title":"List End User Activations","href":"/legacy/api-reference/embedded-api/embedded/list-end-user-activations"}]},{"group":"Activations","pages":[{"openapi":"post /activations","title":"Activate Integration","href":"/legacy/api-reference/embedded-api/activations/activate-integration"},{"openapi":"get /activations/{activation_id}","title":"Retrieve an Activation","href":"/legacy/api-reference/embedded-api/activations/retrieve-an-activation"},{"openapi":"delete /activations/{activation_id}","title":"Delete an Activation","href":"/legacy/api-reference/embedded-api/activations/delete-an-activation"}]},{"group":"Miscellaneous","pages":[{"openapi":"get /healthz","title":"Health Check","href":"/legacy/api-reference/embedded-api/miscellaneous/health-check"}]}]}]},{"anchor":"Organisations API","pages":[{"title":"Organisations API","href":"/legacy/api-reference/organisations-api"}]},{"anchor":"Proxy API","pages":[{"title":"Proxy API","href":"/legacy/api-reference/proxy-api"}]},{"anchor":"Switchboard API","pages":[{"title":"Switchboard API","href":"/legacy/api-reference/switchboard-api/preview-the-output-of-a-transformer"}]}]}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction"}]}]},"title":"Retrieve a Hub - Versori User Documentation","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","Page-kQh739Uz.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}