Present when the workspace owner is temporarily viewing as another member.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Antsfield Docs","colors":{"primary":"#000000","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-light.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=88a1e16eb4ce4435b4cd6f95c20f0fbb","dark":"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-dark.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=e02ae4c0e3ff5b6c9f0b2c75ff4c32f8","href":"https://antsfield.com"},"favicon":"https://mintcdn.com/adiamar/mHedONlAtV_uZvpx/logos/favicon-512x512.png?fit=max\u0026auto=format\u0026n=mHedONlAtV_uZvpx\u0026q=85\u0026s=509367faf60eac2db13fc86b139985aa","api":{"openapi":"https://api.antsfield.com"},"background":{"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.antsfield.com"}},"footer":{"socials":{"twitter":"https://x.com/AntsfieldApp","website":"https://www.antsfield.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"adiamar","hasAudioNarration":false,"actualSubdomain":"adiamar","customDomains":["docs.antsfield.com"],"gitSource":{"type":"github","owner":"skarf4u","repo":"antsfield","deployBranch":"master","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acbfb2884a9a6d4b94d8546","collectionId":"62d649d7-9b44-4523-a163-38cf7e9f6f65","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acbfb2884a9a6d4b94d8546"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6acbfb2884a9a6d4b94d8546","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":35},{"language":"default","tag":"Help Center","count":20},{"language":"default","tag":"Documentation","count":19},{"language":"default","tag":"Using Antsfield","count":14},{"language":"default","tag":"Items","count":10},{"language":"default","tag":"Locations","count":7},{"language":"default","tag":"Inventory","count":7},{"language":"default","tag":"SAML SSO","count":6},{"language":"default","tag":"Transfers","count":5},{"language":"default","tag":"Workspaces","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/retrieve-a-workspace","slug":"/api-reference/endpoint/retrieve-a-workspace","pageMetadata":{"openapi":"get /workspaces/{idOrSlug}","og:title":"Get workspace info with the Antsfield API - API Reference","title":"Retrieve a workspace","description":"Retrieve a workspace for the authenticated user.","href":"/api-reference/endpoint/retrieve-a-workspace"},"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: \"Retrieve a workspace for the authenticated user.\"\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 /workspaces/{idOrSlug}","og:title":"Get workspace info with the Antsfield API - API Reference","title":"Retrieve a workspace","description":"Retrieve a workspace for the authenticated user.","href":"/api-reference/endpoint/retrieve-a-workspace"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getWorkspace","x-speakeasy-name-override":"get","summary":"Retrieve a workspace","description":"Retrieve a workspace for the authenticated user.","tags":["Workspaces"],"security":["45750c7b-0922-4d1a-862c-a921d975a4fc"],"parameters":["7660a72f-c5a8-4f06-a64d-b531c16ba302"],"responses":{"200":"abcad2b1-74dc-4301-a62c-665fddc60fb9","400":"9b0f9ffd-28af-49c6-8646-5d20ca6faaa3","401":"e9ebbb31-1bb2-408c-8ae5-3c1d3e812492","403":"142d9cd8-28fd-4262-880d-93352fd0391e","404":"c2d05ded-7615-4021-8b9b-3e7ac58bdb6d","409":"4e0ca280-1c9f-4f04-989a-931b0cd1eae5","410":"45a6c999-0d4c-4b9a-ad72-fe53e85b5110","422":"6be79d17-9d16-4be2-a0f3-86ebb171934c","429":"3276175f-91b6-42f0-9fea-f8192c65a748","500":"08c7fe21-d9ea-4a57-9b1c-6eac700c62ba"},"method":"get","type":"path","servers":["147c4611-7afc-4c3d-80f3-b0312dd47290"],"path":"/workspaces/{idOrSlug}","baseUrlOptions":["https://api.antsfield.com"],"title":"Retrieve a workspace","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7660a72f-c5a8-4f06-a64d-b531c16ba302":{"in":"path","name":"idOrSlug","description":"The ID or slug of the workspace.","schema":{"type":"string","description":"The ID or slug of the workspace.","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"responses":{"abcad2b1-74dc-4301-a62c-665fddc60fb9":{"description":"The retrieved workspace","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the workspace.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The name of the workspace.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"slug":{"type":"string","description":"The slug of the workspace.","isRequired":true,"uniqueKey":"slug","typeLabel":"string"},"logo":{"oneOf":[{"type":"string","default":null,"description":"The logo of the workspace.","isRequired":true,"uniqueKey":"logo.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"The logo of the workspace.","isRequired":true,"uniqueKey":"logo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"logo","typeLabel":"string | null"},"usage":{"type":"number","description":"The usage of the workspace.","isRequired":true,"uniqueKey":"usage","typeLabel":"number"},"usageLimit":{"type":"number","description":"The usage limit of the workspace.","isRequired":true,"uniqueKey":"usageLimit","typeLabel":"number"},"itemsUsage":{"type":"number","description":"The items usage of the workspace.","isRequired":true,"uniqueKey":"itemsUsage","typeLabel":"number"},"itemsLimit":{"type":"number","description":"The items limit of the workspace.","isRequired":true,"uniqueKey":"itemsLimit","typeLabel":"number"},"billingDocumentsUsage":{"type":"number","description":"Lifetime invoices + estimates created on this workspace.","isRequired":true,"uniqueKey":"billingDocumentsUsage","typeLabel":"number"},"billingDocumentsLimit":{"type":"number","description":"Max billing documents allowed (Free plan quota).","isRequired":true,"uniqueKey":"billingDocumentsLimit","typeLabel":"number"},"suppliersUsage":{"type":"number","description":"The suppliers usage of the workspace.","isRequired":true,"uniqueKey":"suppliersUsage","typeLabel":"number"},"suppliersLimit":{"type":"number","description":"The suppliers limit of the workspace.","isRequired":true,"uniqueKey":"suppliersLimit","typeLabel":"number"},"locationsUsage":{"type":"number","description":"The locations usage of the workspace.","isRequired":true,"uniqueKey":"locationsUsage","typeLabel":"number"},"locationsLimit":{"type":"number","description":"The locations limit of the workspace.","isRequired":true,"uniqueKey":"locationsLimit","typeLabel":"number"},"defaultLocationId":{"oneOf":[{"type":"string","default":null,"description":"The ID of the default 'Inventory' location.","isRequired":true,"uniqueKey":"defaultLocationId.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"The ID of the default 'Inventory' location.","isRequired":true,"uniqueKey":"defaultLocationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultLocationId","typeLabel":"string | null"},"defaultCurrency":{"type":"string","minLength":3,"maxLength":3,"description":"Default currency for jobs and monetary displays.","isRequired":true,"uniqueKey":"defaultCurrency","typeLabel":"string"},"invoiceNumberPrefix":{"type":"string","enum":["INV"],"description":"Fixed prefix used when generating invoice numbers.","isRequired":true,"uniqueKey":"invoiceNumberPrefix","typeLabel":"enum\u003cstring>"},"defaultTaxPercent":{"type":"number","minimum":0,"maximum":100,"description":"Default tax rate applied when closing jobs.","isRequired":true,"uniqueKey":"defaultTaxPercent","typeLabel":"number"},"defaultTaxIncluded":{"type":"boolean","description":"When true, line prices include tax; when false, tax is added on top.","isRequired":true,"uniqueKey":"defaultTaxIncluded","typeLabel":"boolean"},"defaultInvoiceDueDays":{"type":"integer","minimum":0,"maximum":365,"description":"Days after creation when new invoices are due by default (0 = no default due date).","isRequired":true,"uniqueKey":"defaultInvoiceDueDays","typeLabel":"integer"},"defaultInvoiceNote":{"oneOf":[{"type":"string","default":null,"description":"Default note/payment terms pre-filled on new invoices.","isRequired":true,"uniqueKey":"defaultInvoiceNote.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Default note/payment terms pre-filled on new invoices.","isRequired":true,"uniqueKey":"defaultInvoiceNote.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultInvoiceNote","typeLabel":"string | null"},"defaultEstimateNote":{"oneOf":[{"type":"string","default":null,"description":"Default note/payment terms pre-filled on new estimates.","isRequired":true,"uniqueKey":"defaultEstimateNote.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Default note/payment terms pre-filled on new estimates.","isRequired":true,"uniqueKey":"defaultEstimateNote.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultEstimateNote","typeLabel":"string | null"},"invoicingBusinessName":{"oneOf":[{"type":"string","default":null,"description":"Business name shown on invoices and estimates.","isRequired":true,"uniqueKey":"invoicingBusinessName.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Business name shown on invoices and estimates.","isRequired":true,"uniqueKey":"invoicingBusinessName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingBusinessName","typeLabel":"string | null"},"invoicingBrandColor":{"oneOf":[{"type":"string","default":null,"description":"Accent color used on client-facing billing documents.","isRequired":true,"uniqueKey":"invoicingBrandColor.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Accent color used on client-facing billing documents.","isRequired":true,"uniqueKey":"invoicingBrandColor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingBrandColor","typeLabel":"string | null"},"invoicingEmail":{"oneOf":[{"type":"string","default":null,"description":"Contact email shown on billing documents.","isRequired":true,"uniqueKey":"invoicingEmail.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Contact email shown on billing documents.","isRequired":true,"uniqueKey":"invoicingEmail.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingEmail","typeLabel":"string | null"},"invoicingPhone":{"oneOf":[{"type":"string","default":null,"description":"Contact phone shown on billing documents.","isRequired":true,"uniqueKey":"invoicingPhone.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Contact phone shown on billing documents.","isRequired":true,"uniqueKey":"invoicingPhone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingPhone","typeLabel":"string | null"},"invoicingAddress":{"oneOf":[{"type":"string","default":null,"description":"Business address shown on billing documents.","isRequired":true,"uniqueKey":"invoicingAddress.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Business address shown on billing documents.","isRequired":true,"uniqueKey":"invoicingAddress.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingAddress","typeLabel":"string | null"},"invoicingWebsite":{"oneOf":[{"type":"string","default":null,"description":"Website shown on billing documents.","isRequired":true,"uniqueKey":"invoicingWebsite.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Website shown on billing documents.","isRequired":true,"uniqueKey":"invoicingWebsite.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingWebsite","typeLabel":"string | null"},"invoicingLogoUrl":{"oneOf":[{"type":"string","default":null,"description":"Custom logo URL for invoices and estimates (overrides workspace logo).","isRequired":true,"uniqueKey":"invoicingLogoUrl.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Custom logo URL for invoices and estimates (overrides workspace logo).","isRequired":true,"uniqueKey":"invoicingLogoUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"invoicingLogoUrl","typeLabel":"string | null"},"invoicingPdfTemplate":{"type":"string","enum":["classic","modern","minimal","impact","elegant","showcase"],"default":"classic","description":"PDF layout for invoices and estimates.","isRequired":true,"uniqueKey":"invoicingPdfTemplate","typeLabel":"enum\u003cstring>"},"defaultInvoiceSourceLocationId":{"oneOf":[{"type":"string","default":null,"description":"Default source location when closing jobs.","isRequired":true,"uniqueKey":"defaultInvoiceSourceLocationId.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Default source location when closing jobs.","isRequired":true,"uniqueKey":"defaultInvoiceSourceLocationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultInvoiceSourceLocationId","typeLabel":"string | null"},"defaultTransferFromLocationId":{"oneOf":[{"type":"string","default":null,"description":"Default source location when creating transfers.","isRequired":true,"uniqueKey":"defaultTransferFromLocationId.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Default source location when creating transfers.","isRequired":true,"uniqueKey":"defaultTransferFromLocationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultTransferFromLocationId","typeLabel":"string | null"},"defaultLocationType":{"type":"string","enum":["warehouse","van","truck","site","other"],"description":"Default type for newly created locations.","isRequired":true,"uniqueKey":"defaultLocationType","typeLabel":"enum\u003cstring>"},"defaultMarkupPercent":{"oneOf":[{"type":"number","minimum":0,"maximum":1000,"description":"Default markup percentage applied from unit cost to sell price.","isRequired":true,"uniqueKey":"defaultMarkupPercent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1000,"description":"Default markup percentage applied from unit cost to sell price.","isRequired":true,"uniqueKey":"defaultMarkupPercent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultMarkupPercent","typeLabel":"number | null"},"tagsLimit":{"type":"number","description":"The tags limit of the workspace.","isRequired":true,"uniqueKey":"tagsLimit","typeLabel":"number"},"usersLimit":{"type":"number","description":"The users limit of the workspace.","isRequired":true,"uniqueKey":"usersLimit","typeLabel":"number"},"plan":{"type":"string","enum":["free","pro","business","advanced","business plus","business extra","business max","enterprise"],"description":"The plan of the workspace.","isRequired":true,"uniqueKey":"plan","typeLabel":"enum\u003cstring>"},"stripeId":{"oneOf":[{"type":"string","description":"The Stripe ID of the workspace.","isRequired":true,"uniqueKey":"stripeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Stripe ID of the workspace.","isRequired":true,"uniqueKey":"stripeId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"stripeId","typeLabel":"string | null"},"appleOriginalTransactionId":{"oneOf":[{"type":"string","default":null,"description":"The Apple In-App Purchase subscription linked to the workspace, if billing is managed through the App Store.","isRequired":true,"uniqueKey":"appleOriginalTransactionId.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"The Apple In-App Purchase subscription linked to the workspace, if billing is managed through the App Store.","isRequired":true,"uniqueKey":"appleOriginalTransactionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"appleOriginalTransactionId","typeLabel":"string | null"},"billingCycleStart":{"type":"number","description":"The date and time when the billing cycle starts for the workspace.","isRequired":true,"uniqueKey":"billingCycleStart","typeLabel":"number"},"createdAt":{"type":"string","description":"The date and time when the workspace was created.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"trialEndsAt":{"oneOf":[{"type":"string","description":"When the workspace billing trial ends, if applicable.","isRequired":true,"uniqueKey":"trialEndsAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the workspace billing trial ends, if applicable.","isRequired":true,"uniqueKey":"trialEndsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"trialEndsAt","typeLabel":"string | null"},"billingCycleEndsAt":{"oneOf":[{"type":"string","description":"When the current billing cycle ends.","isRequired":true,"uniqueKey":"billingCycleEndsAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the current billing cycle ends.","isRequired":true,"uniqueKey":"billingCycleEndsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"billingCycleEndsAt","typeLabel":"string | null"},"subscriptionCanceledAt":{"oneOf":[{"type":"string","description":"When the workspace subscription was canceled.","isRequired":true,"uniqueKey":"subscriptionCanceledAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the workspace subscription was canceled.","isRequired":true,"uniqueKey":"subscriptionCanceledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subscriptionCanceledAt","typeLabel":"string | null"},"paymentFailedAt":{"oneOf":[{"type":"string","description":"When the last platform subscription payment failed.","isRequired":true,"uniqueKey":"paymentFailedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the last platform subscription payment failed.","isRequired":true,"uniqueKey":"paymentFailedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentFailedAt","typeLabel":"string | null"},"users":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["owner","admin","employee","viewer","billing"],"description":"The role of the authenticated user in the workspace.","isRequired":true,"uniqueKey":"users.items.[INDEX].role","typeLabel":"enum\u003cstring>"}},"required":["role"],"uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"description":"The role of the authenticated user in the workspace.","isRequired":true,"uniqueKey":"users","typeLabel":"object[]"},"inviteCode":{"oneOf":[{"type":"string","description":"The invite code of the workspace.","isRequired":true,"uniqueKey":"inviteCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"The invite code of the workspace.","isRequired":true,"uniqueKey":"inviteCode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"inviteCode","typeLabel":"string | null"},"ssoEmailDomain":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ssoEmailDomain.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ssoEmailDomain.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ssoEmailDomain","typeLabel":"string | null"},"ssoEnforcedAt":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"ssoEnforcedAt.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"ssoEnforcedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ssoEnforcedAt","typeLabel":"string | null"},"paymentReminderEnabled":{"type":"boolean","isRequired":true,"uniqueKey":"paymentReminderEnabled","typeLabel":"boolean"},"paymentReminderDaysBefore":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"paymentReminderDaysBefore.oneOf.0.items.[INDEX]","typeLabel":"integer"},"default":null,"isRequired":true,"uniqueKey":"paymentReminderDaysBefore.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"default":null,"isRequired":true,"uniqueKey":"paymentReminderDaysBefore.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentReminderDaysBefore","typeLabel":"integer[] | null"},"paymentReminderOffsets":{"oneOf":[{"type":"array","items":{"type":"integer","minimum":-365,"maximum":365,"uniqueKey":"paymentReminderOffsets.oneOf.0.items.[INDEX]","typeLabel":"integer"},"maxItems":10,"default":null,"isRequired":true,"uniqueKey":"paymentReminderOffsets.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer","minimum":-365,"maximum":365},"maxItems":10,"default":null,"isRequired":true,"uniqueKey":"paymentReminderOffsets.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"paymentReminderOffsets","typeLabel":"integer[] | null"},"emailMessageUseGeneric":{"type":"boolean","default":true,"isRequired":true,"uniqueKey":"emailMessageUseGeneric","typeLabel":"boolean"},"emailMessageDefault":{"oneOf":[{"type":"string","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageDefault.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageDefault.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailMessageDefault","typeLabel":"string | null"},"emailMessageInvoice":{"oneOf":[{"type":"string","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageInvoice.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageInvoice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailMessageInvoice","typeLabel":"string | null"},"emailMessageEstimate":{"oneOf":[{"type":"string","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageEstimate.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":5000,"default":null,"isRequired":true,"uniqueKey":"emailMessageEstimate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailMessageEstimate","typeLabel":"string | null"},"emailMessageCc":{"oneOf":[{"type":"string","format":"email","default":null,"isRequired":true,"uniqueKey":"emailMessageCc.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","default":null,"isRequired":true,"uniqueKey":"emailMessageCc.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailMessageCc","typeLabel":"string\u003cemail> | null"},"emailMessageBcc":{"oneOf":[{"type":"string","format":"email","default":null,"isRequired":true,"uniqueKey":"emailMessageBcc.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","format":"email","default":null,"isRequired":true,"uniqueKey":"emailMessageBcc.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"emailMessageBcc","typeLabel":"string\u003cemail> | null"},"paymentNoteEnabled":{"type":"boolean","default":true,"isRequired":true,"uniqueKey":"paymentNoteEnabled","typeLabel":"boolean"},"paymentReceiptEnabled":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"paymentReceiptEnabled","typeLabel":"boolean"},"taxCountry":{"oneOf":[{"type":"string","default":null,"isRequired":true,"uniqueKey":"taxCountry.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"isRequired":true,"uniqueKey":"taxCountry.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"taxCountry","typeLabel":"string | null"},"taxRegistrationNumber":{"oneOf":[{"type":"string","default":null,"isRequired":true,"uniqueKey":"taxRegistrationNumber.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"isRequired":true,"uniqueKey":"taxRegistrationNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"taxRegistrationNumber","typeLabel":"string | null"},"taxYearStartMonth":{"type":"integer","minimum":1,"maximum":12,"default":1,"isRequired":true,"uniqueKey":"taxYearStartMonth","typeLabel":"integer"},"taxYearStartDay":{"type":"integer","minimum":1,"maximum":31,"default":1,"isRequired":true,"uniqueKey":"taxYearStartDay","typeLabel":"integer"},"withholdingTaxEnabled":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"withholdingTaxEnabled","typeLabel":"boolean"},"withholdingTaxLabel":{"oneOf":[{"type":"string","default":"Withholding Tax","isRequired":true,"uniqueKey":"withholdingTaxLabel.oneOf.0","typeLabel":"string"},{"type":"null","default":"Withholding Tax","isRequired":true,"uniqueKey":"withholdingTaxLabel.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"withholdingTaxLabel","typeLabel":"string | null"},"withholdingTaxPercent":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"default":null,"isRequired":true,"uniqueKey":"withholdingTaxPercent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"default":null,"isRequired":true,"uniqueKey":"withholdingTaxPercent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"withholdingTaxPercent","typeLabel":"number | null"},"taxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"taxes.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"taxes.items.[INDEX].name","typeLabel":"string"},"ratePercent":{"type":"number","isRequired":true,"uniqueKey":"taxes.items.[INDEX].ratePercent","typeLabel":"number"},"taxType":{"type":"string","enum":["exclusive","inclusive"],"isRequired":true,"uniqueKey":"taxes.items.[INDEX].taxType","typeLabel":"enum\u003cstring>"},"appliesToAllItems":{"type":"boolean","isRequired":true,"uniqueKey":"taxes.items.[INDEX].appliesToAllItems","typeLabel":"boolean"},"sortOrder":{"type":"integer","isRequired":true,"uniqueKey":"taxes.items.[INDEX].sortOrder","typeLabel":"integer"}},"required":["id","name","ratePercent","taxType","appliesToAllItems","sortOrder"],"uniqueKey":"taxes.items.[INDEX]","typeLabel":"object"},"default":[],"description":"Named tax rates configured under Tax settings \u0026 currency.","isRequired":true,"uniqueKey":"taxes","typeLabel":"object[]"},"clientFollowUpEnabled":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"clientFollowUpEnabled","typeLabel":"boolean"},"clientFollowUpDefaultMonths":{"type":"integer","default":6,"isRequired":true,"uniqueKey":"clientFollowUpDefaultMonths","typeLabel":"integer"},"clientFollowUpDefaultOnInvoice":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"clientFollowUpDefaultOnInvoice","typeLabel":"boolean"},"clientFollowUpSubject":{"oneOf":[{"type":"string","default":null,"isRequired":true,"uniqueKey":"clientFollowUpSubject.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"isRequired":true,"uniqueKey":"clientFollowUpSubject.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"clientFollowUpSubject","typeLabel":"string | null"},"clientFollowUpBody":{"oneOf":[{"type":"string","default":null,"isRequired":true,"uniqueKey":"clientFollowUpBody.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"isRequired":true,"uniqueKey":"clientFollowUpBody.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"clientFollowUpBody","typeLabel":"string | null"},"shiftLiveLocationEnabled":{"type":"boolean","default":true,"description":"Whether live location pings are recorded during active shifts.","isRequired":true,"uniqueKey":"shiftLiveLocationEnabled","typeLabel":"boolean"},"estimateNumberPrefix":{"type":"string","enum":["EST"],"default":"EST","description":"Fixed prefix used when generating estimate numbers.","isRequired":true,"uniqueKey":"estimateNumberPrefix","typeLabel":"enum\u003cstring>"},"autoServiceCallLineEnabled":{"type":"boolean","default":false,"description":"Whether new invoices/estimates get a default service-call line.","isRequired":true,"uniqueKey":"autoServiceCallLineEnabled","typeLabel":"boolean"},"deductInventoryOnInvoice":{"type":"boolean","default":true,"description":"Whether sending an invoice deducts catalog item stock from the source location.","isRequired":true,"uniqueKey":"deductInventoryOnInvoice","typeLabel":"boolean"},"defaultLowStockThreshold":{"type":"integer","minimum":0,"default":5,"description":"Default low-stock threshold for items without an override. 0 means only exact zero is treated as out of stock.","isRequired":true,"uniqueKey":"defaultLowStockThreshold","typeLabel":"integer"},"stockDigestEnabled":{"type":"boolean","default":false,"description":"Whether to send a weekly stock-health digest to owners/admins with inventory alerts on.","isRequired":true,"uniqueKey":"stockDigestEnabled","typeLabel":"boolean"},"serviceCallLabel":{"oneOf":[{"type":"string","default":null,"description":"Label for the default service-call line item.","isRequired":true,"uniqueKey":"serviceCallLabel.oneOf.0","typeLabel":"string"},{"type":"null","default":null,"description":"Label for the default service-call line item.","isRequired":true,"uniqueKey":"serviceCallLabel.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"serviceCallLabel","typeLabel":"string | null"},"serviceCallPriceCents":{"oneOf":[{"type":"integer","default":null,"description":"Unit price in cents for the default service-call line.","isRequired":true,"uniqueKey":"serviceCallPriceCents.oneOf.0","typeLabel":"integer"},{"type":"null","default":null,"description":"Unit price in cents for the default service-call line.","isRequired":true,"uniqueKey":"serviceCallPriceCents.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"serviceCallPriceCents","typeLabel":"integer | null"},"serviceCallQuantity":{"type":"integer","default":1,"description":"Quantity for the default service-call line.","isRequired":true,"uniqueKey":"serviceCallQuantity","typeLabel":"integer"},"defaultDepositPercent":{"oneOf":[{"type":"number","default":null,"description":"Default deposit percent suggested on invoices.","isRequired":true,"uniqueKey":"defaultDepositPercent.oneOf.0","typeLabel":"number"},{"type":"null","default":null,"description":"Default deposit percent suggested on invoices.","isRequired":true,"uniqueKey":"defaultDepositPercent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"defaultDepositPercent","typeLabel":"number | null"},"invoicingOnlinePaymentsEnabled":{"type":"boolean","default":false,"description":"Whether online payment collection is enabled for invoices.","isRequired":true,"uniqueKey":"invoicingOnlinePaymentsEnabled","typeLabel":"boolean"},"stripeConnectChargesEnabled":{"type":"boolean","default":false,"description":"Whether Stripe Connect is ready to accept charges.","isRequired":true,"uniqueKey":"stripeConnectChargesEnabled","typeLabel":"boolean"},"locationAccess":{"type":"object","properties":{"restricted":{"type":"boolean","isRequired":true,"uniqueKey":"locationAccess.restricted","typeLabel":"boolean"},"locations":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"locationAccess.locations.items.[INDEX].locationId","typeLabel":"string"},"accessLevel":{"type":"string","enum":["read","write"],"isRequired":true,"uniqueKey":"locationAccess.locations.items.[INDEX].accessLevel","typeLabel":"enum\u003cstring>"}},"required":["locationId","accessLevel"],"uniqueKey":"locationAccess.locations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"locationAccess.locations","typeLabel":"object[]"}},"required":["restricted","locations"],"description":"Location access for the authenticated member.","uniqueKey":"locationAccess","typeLabel":"object"},"memberPermissions":{"type":"object","properties":{"capabilities":{"type":"object","additionalProperties":{"type":"boolean","uniqueKey":"memberPermissions.capabilities.additionalProperties","typeLabel":"boolean"},"isRequired":true,"uniqueKey":"memberPermissions.capabilities","typeLabel":"object"},"profile":{"type":"object","properties":{"builtinTemplateKey":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"memberPermissions.profile.builtinTemplateKey.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"memberPermissions.profile.builtinTemplateKey.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"memberPermissions.profile.builtinTemplateKey","typeLabel":"string | null"},"customTemplateId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateId","typeLabel":"string | null"},"customTemplateName":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateName.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"memberPermissions.profile.customTemplateName","typeLabel":"string | null"},"overrideCount":{"type":"number","isRequired":true,"uniqueKey":"memberPermissions.profile.overrideCount","typeLabel":"number"},"permissionsManaged":{"type":"boolean","isRequired":true,"uniqueKey":"memberPermissions.profile.permissionsManaged","typeLabel":"boolean"},"legacyUnrestricted":{"type":"boolean","isRequired":true,"uniqueKey":"memberPermissions.profile.legacyUnrestricted","typeLabel":"boolean"}},"required":["builtinTemplateKey","customTemplateId","customTemplateName","overrideCount","permissionsManaged","legacyUnrestricted"],"isRequired":true,"uniqueKey":"memberPermissions.profile","typeLabel":"object"}},"required":["capabilities","profile"],"description":"Effective member capabilities for the authenticated user.","uniqueKey":"memberPermissions","typeLabel":"object"},"impersonation":{"type":"object","properties":{"active":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"impersonation.active","typeLabel":"enum\u003cboolean>"},"actorIsOwner":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"impersonation.actorIsOwner","typeLabel":"enum\u003cboolean>"},"target":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"impersonation.target.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"impersonation.target.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"impersonation.target.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"impersonation.target.name","typeLabel":"string | null"},"email":{"type":"string","isRequired":true,"uniqueKey":"impersonation.target.email","typeLabel":"string"},"image":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"impersonation.target.image.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"impersonation.target.image.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"impersonation.target.image","typeLabel":"string | null"}},"required":["id","name","email","image"],"isRequired":true,"uniqueKey":"impersonation.target","typeLabel":"object"},"startedAt":{"type":"string","isRequired":true,"uniqueKey":"impersonation.startedAt","typeLabel":"string"},"expiresAt":{"type":"string","isRequired":true,"uniqueKey":"impersonation.expiresAt","typeLabel":"string"}},"required":["active","actorIsOwner","target","startedAt","expiresAt"],"description":"Present when the workspace owner is temporarily viewing as another member.","uniqueKey":"impersonation","typeLabel":"object"}},"required":["id","name","slug","logo","usage","usageLimit","itemsUsage","itemsLimit","billingDocumentsUsage","billingDocumentsLimit","suppliersUsage","suppliersLimit","locationsUsage","locationsLimit","defaultLocationId","defaultCurrency","invoiceNumberPrefix","defaultTaxPercent","defaultTaxIncluded","defaultInvoiceDueDays","defaultInvoiceNote","defaultEstimateNote","invoicingBusinessName","invoicingBrandColor","invoicingEmail","invoicingPhone","invoicingAddress","invoicingWebsite","invoicingLogoUrl","invoicingPdfTemplate","defaultInvoiceSourceLocationId","defaultTransferFromLocationId","defaultLocationType","defaultMarkupPercent","tagsLimit","usersLimit","plan","stripeId","appleOriginalTransactionId","billingCycleStart","createdAt","trialEndsAt","billingCycleEndsAt","subscriptionCanceledAt","paymentFailedAt","users","inviteCode","ssoEmailDomain","ssoEnforcedAt","paymentReminderEnabled","paymentReminderDaysBefore","paymentReminderOffsets","emailMessageUseGeneric","emailMessageDefault","emailMessageInvoice","emailMessageEstimate","emailMessageCc","emailMessageBcc","paymentNoteEnabled","paymentReceiptEnabled","taxCountry","taxRegistrationNumber","taxYearStartMonth","taxYearStartDay","withholdingTaxEnabled","withholdingTaxLabel","withholdingTaxPercent","taxes","clientFollowUpEnabled","clientFollowUpDefaultMonths","clientFollowUpDefaultOnInvoice","clientFollowUpSubject","clientFollowUpBody","shiftLiveLocationEnabled","estimateNumberPrefix","autoServiceCallLineEnabled","deductInventoryOnInvoice","defaultLowStockThreshold","stockDigestEnabled","serviceCallLabel","serviceCallPriceCents","serviceCallQuantity","defaultDepositPercent","invoicingOnlinePaymentsEnabled","stripeConnectChargesEnabled"],"title":"Workspace","uniqueKey":"","typeLabel":"Workspace · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","slug":"\u003cstring>","logo":null,"usage":123,"usageLimit":123,"itemsUsage":123,"itemsLimit":123,"billingDocumentsUsage":123,"billingDocumentsLimit":123,"suppliersUsage":123,"suppliersLimit":123,"locationsUsage":123,"locationsLimit":123,"defaultLocationId":null,"defaultCurrency":"\u003cstring>","invoiceNumberPrefix":"INV","defaultTaxPercent":50,"defaultTaxIncluded":true,"defaultInvoiceDueDays":182,"defaultInvoiceNote":null,"defaultEstimateNote":null,"invoicingBusinessName":null,"invoicingBrandColor":null,"invoicingEmail":null,"invoicingPhone":null,"invoicingAddress":null,"invoicingWebsite":null,"invoicingLogoUrl":null,"invoicingPdfTemplate":"classic","defaultInvoiceSourceLocationId":null,"defaultTransferFromLocationId":null,"defaultLocationType":"warehouse","defaultMarkupPercent":500,"tagsLimit":123,"usersLimit":123,"plan":"free","stripeId":"\u003cstring>","appleOriginalTransactionId":null,"billingCycleStart":123,"createdAt":"\u003cstring>","trialEndsAt":"\u003cstring>","billingCycleEndsAt":"\u003cstring>","subscriptionCanceledAt":"\u003cstring>","paymentFailedAt":"\u003cstring>","users":[{"role":"owner"}],"inviteCode":"\u003cstring>","ssoEmailDomain":"\u003cstring>","ssoEnforcedAt":"\u003cstring>","paymentReminderEnabled":true,"paymentReminderDaysBefore":null,"paymentReminderOffsets":null,"emailMessageUseGeneric":true,"emailMessageDefault":null,"emailMessageInvoice":null,"emailMessageEstimate":null,"emailMessageCc":null,"emailMessageBcc":null,"paymentNoteEnabled":true,"paymentReceiptEnabled":false,"taxCountry":null,"taxRegistrationNumber":null,"taxYearStartMonth":1,"taxYearStartDay":1,"withholdingTaxEnabled":false,"withholdingTaxLabel":"Withholding Tax","withholdingTaxPercent":null,"taxes":[],"clientFollowUpEnabled":false,"clientFollowUpDefaultMonths":6,"clientFollowUpDefaultOnInvoice":false,"clientFollowUpSubject":null,"clientFollowUpBody":null,"shiftLiveLocationEnabled":true,"estimateNumberPrefix":"EST","autoServiceCallLineEnabled":false,"deductInventoryOnInvoice":true,"defaultLowStockThreshold":5,"stockDigestEnabled":false,"serviceCallLabel":null,"serviceCallPriceCents":null,"serviceCallQuantity":1,"defaultDepositPercent":null,"invoicingOnlinePaymentsEnabled":false,"stripeConnectChargesEnabled":false,"locationAccess":{"restricted":true,"locations":[{"locationId":"\u003cstring>","accessLevel":"read"}]},"memberPermissions":{"capabilities":{},"profile":{"builtinTemplateKey":"\u003cstring>","customTemplateId":"\u003cstring>","customTemplateName":"\u003cstring>","overrideCount":123,"permissionsManaged":true,"legacyUnrestricted":true}},"impersonation":{"active":true,"actorIsOwner":true,"target":{"id":"\u003cstring>","name":"\u003cstring>","email":"\u003cstring>","image":"\u003cstring>"},"startedAt":"\u003cstring>","expiresAt":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9b0f9ffd-28af-49c6-8646-5d20ca6faaa3":{"description":"The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","content":{"application/json":{"schema":{"x-speakeasy-name-override":"BadRequest","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["bad_request"],"description":"A short code indicating the error code returned.","example":"bad_request","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#bad-request","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"bad_request","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#bad-request"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e9ebbb31-1bb2-408c-8ae5-3c1d3e812492":{"description":"Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Unauthorized","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unauthorized"],"description":"A short code indicating the error code returned.","example":"unauthorized","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#unauthorized","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#unauthorized"}}}},"exampleType":"generated"}},"exampleType":"generated"},"142d9cd8-28fd-4262-880d-93352fd0391e":{"description":"The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Forbidden","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["forbidden"],"description":"A short code indicating the error code returned.","example":"forbidden","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#forbidden","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"forbidden","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#forbidden"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c2d05ded-7615-4021-8b9b-3e7ac58bdb6d":{"description":"The server cannot find the requested resource.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"NotFound","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["not_found"],"description":"A short code indicating the error code returned.","example":"not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#not-found","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#not-found"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4e0ca280-1c9f-4f04-989a-931b0cd1eae5":{"description":"This response is sent when a request conflicts with the current state of the server.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"Conflict","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["conflict"],"description":"A short code indicating the error code returned.","example":"conflict","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#conflict","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"conflict","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#conflict"}}}},"exampleType":"generated"}},"exampleType":"generated"},"45a6c999-0d4c-4b9a-ad72-fe53e85b5110":{"description":"This response is sent when the requested content has been permanently deleted from server, with no forwarding address.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InviteExpired","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["invite_expired"],"description":"A short code indicating the error code returned.","example":"invite_expired","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#invite-expired","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invite_expired","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#invite-expired"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6be79d17-9d16-4be2-a0f3-86ebb171934c":{"description":"The request was well-formed but was unable to be followed due to semantic errors.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"UnprocessableEntity","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["unprocessable_entity"],"description":"A short code indicating the error code returned.","example":"unprocessable_entity","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#unprocessable-entity","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unprocessable_entity","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#unprocessable-entity"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3276175f-91b6-42f0-9fea-f8192c65a748":{"description":"The user has sent too many requests in a given amount of time (\"rate limiting\")","content":{"application/json":{"schema":{"x-speakeasy-name-override":"RateLimitExceeded","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["rate_limit_exceeded"],"description":"A short code indicating the error code returned.","example":"rate_limit_exceeded","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#rate-limit_exceeded","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#rate-limit_exceeded"}}}},"exampleType":"generated"}},"exampleType":"generated"},"08c7fe21-d9ea-4a57-9b1c-6eac700c62ba":{"description":"The server has encountered a situation it does not know how to handle.","content":{"application/json":{"schema":{"x-speakeasy-name-override":"InternalServerError","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["internal_server_error"],"description":"A short code indicating the error code returned.","example":"internal_server_error","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable explanation of what went wrong.","example":"The requested resource was not found.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"doc_url":{"type":"string","description":"A link to our documentation with more details about this error code","example":"https://docs.antsfield.com/api-reference/errors#internal-server_error","uniqueKey":"error.doc_url","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"internal_server_error","message":"The requested resource was not found.","doc_url":"https://docs.antsfield.com/api-reference/errors#internal-server_error"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"45750c7b-0922-4d1a-862c-a921d975a4fc":{"token":{"type":"http","description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"token"}}},"servers":{"147c4611-7afc-4c3d-80f3-b0312dd47290":{"url":"https://api.antsfield.com","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","scheme":"bearer","bearerFormat":"API key","scopes":[],"schemeName":"token"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer API key from Settings → API Keys. Use restricted keys (prefix `retrac_`) with the minimum scopes required.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"token","name":"Authorization"}],"title":"token"}]},"originalFileLocation":"https://api.antsfield.com"},"subdomain":"adiamar","siteName":"Antsfield Docs","title":"Get workspace info with the Antsfield API - API Reference","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T01:50:56.328Z","originalFileLocation":"api-reference/endpoint/retrieve-a-workspace.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=\"Retrieve a workspace for the authenticated user.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Antsfield Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_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/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get workspace info with the Antsfield API - API Reference\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a workspace for the authenticated user.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Antsfield Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://adiamar.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Retrieve+a+workspace\u0026amp;description=Retrieve+a+workspace+for+the+authenticated+user.\u0026amp;theme=c243e068992cce0ce99326b4\u0026amp;signature=ed935ec4752f8bb6fab0a3eab96ad15d34f41f2bc73ff322eb4908f1495a9e2e\">\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 workspace info with the Antsfield API - API Reference\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a workspace for the authenticated user.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://adiamar.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Retrieve+a+workspace\u0026amp;description=Retrieve+a+workspace+for+the+authenticated+user.\u0026amp;theme=c243e068992cce0ce99326b4\u0026amp;signature=ed935ec4752f8bb6fab0a3eab96ad15d34f41f2bc73ff322eb4908f1495a9e2e\">\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/adiamar/ZOwRp_NrhVBnGhrY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Antsfield Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/retrieve-a-workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.antsfield.com/#organization\",\"name\":\"Antsfield Docs\",\"url\":\"https://docs.antsfield.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/adiamar/89QSU7keLFLF5xC2/logos/full-logo-light.png?fit=max\u0026auto=format\u0026n=89QSU7keLFLF5xC2\u0026q=85\u0026s=88a1e16eb4ce4435b4cd6f95c20f0fbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.antsfield.com#website\",\"name\":\"Antsfield Docs\",\"url\":\"https://docs.antsfield.com\",\"publisher\":{\"@id\":\"https://docs.antsfield.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace#webpage\",\"url\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace\",\"name\":\"Retrieve a workspace\",\"description\":\"Retrieve a workspace for the authenticated user.\",\"dateModified\":\"2026-01-07T01:50:56.328Z\",\"isPartOf\":{\"@id\":\"https://docs.antsfield.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Workspaces\",\"item\":\"https://docs.antsfield.com/api-reference/endpoint/create-a-new-workspace\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a workspace\",\"item\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace#apireference\",\"headline\":\"Retrieve a workspace\",\"name\":\"Retrieve a workspace\",\"description\":\"Retrieve a workspace for the authenticated user.\",\"url\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.antsfield.com/api-reference/endpoint/retrieve-a-workspace#webpage\"},\"dateModified\":\"2026-01-07T01:50:56.328Z\",\"publisher\":{\"@id\":\"https://docs.antsfield.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.antsfield.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Antsfield Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Antsfield Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"webhook","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Security","icon":"shield","href":"/api-reference/security"},{"title":"Rate limits","icon":"clock","href":"/api-reference/rate-limits"},{"title":"Errors","icon":"bug","href":"/api-reference/errors"}]},{"group":"Items","pages":[{"openapi":"post /items","title":"Create a new item","href":"/api-reference/endpoint/create-a-new-item"},{"openapi":"get /items/info","title":"Retrieve an item","href":"/api-reference/endpoint/retrieve-an-item"},{"openapi":"patch /items/{itemId}","title":"Update an item","href":"/api-reference/endpoint/update-an-item"},{"openapi":"delete /items/{itemId}","title":"Delete an item","href":"/api-reference/endpoint/delete-an-item"},{"openapi":"get /items","title":"Retrieve a list of items","href":"/api-reference/endpoint/retrieve-a-list-of-items"},{"openapi":"get /items/count","title":"Retrieve the number of items","href":"/api-reference/endpoint/retrieve-number-of-items"},{"openapi":"post /items/bulk","title":"Bulk create items","href":"/api-reference/endpoint/bulk-create-items"}]},{"group":"Workspaces","pages":[{"openapi":"post /workspaces","title":"Create a workspace","description":"Create a new workspace for the authenticated user.","href":"/api-reference/endpoint/create-a-new-workspace"},{"openapi":"get /workspaces/{idOrSlug}","title":"Retrieve a workspace","href":"/api-reference/endpoint/retrieve-a-workspace"},{"openapi":"get /workspaces","title":"Retrieve a list of workspaces","description":"Retrieve a list of workspaces for the authenticated user.","href":"/api-reference/endpoint/retrieve-a-list-of-workspaces"}]},{"group":"Tags","pages":[{"openapi":"post /tags","title":"Create a new tag","href":"/api-reference/endpoint/create-a-new-tag"},{"openapi":"get /tags","title":"Retrieve a list of tags","href":"/api-reference/endpoint/retrieve-a-list-of-tags"}]},{"group":"Locations","pages":[{"openapi":"post /locations","title":"Create a location","href":"/api-reference/endpoint/create-a-location"},{"openapi":"get /locations/{id}","title":"Retrieve a location","href":"/api-reference/endpoint/retrieve-a-location"},{"openapi":"patch /locations/{id}","title":"Update a location","href":"/api-reference/endpoint/update-a-location"},{"openapi":"delete /locations/{id}","title":"Delete a location","href":"/api-reference/endpoint/delete-a-location"},{"openapi":"get /locations","title":"Retrieve a list of locations","href":"/api-reference/endpoint/retrieve-a-list-of-locations"},{"openapi":"get /locations/count","title":"Retrieve the number of locations","href":"/api-reference/endpoint/retrieve-number-of-locations"}]},{"group":"Inventory","pages":[{"openapi":"get /inventory/balances","title":"List inventory balances","href":"/api-reference/endpoint/list-inventory-balances"},{"openapi":"put /inventory/balances","title":"Set on-hand stock","href":"/api-reference/endpoint/set-on-hand-stock"},{"openapi":"get /inventory/movements","title":"List inventory movements","href":"/api-reference/endpoint/list-inventory-movements"}]},{"group":"Transfers","pages":[{"openapi":"post /inventory/transfers","title":"Create a transfer","href":"/api-reference/endpoint/create-a-transfer"},{"openapi":"get /inventory/transfers/{id}","title":"Retrieve a transfer","href":"/api-reference/endpoint/retrieve-a-transfer"},{"openapi":"get /inventory/transfers","title":"List transfers","href":"/api-reference/endpoint/list-transfers"},{"openapi":"post /inventory/transfers/{id}/revert","title":"Revert a transfer","href":"/api-reference/endpoint/revert-a-transfer"}]}]}]},"basePath":"","title":"Get workspace info with the Antsfield API - API Reference","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}