v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Retrieve Workspace

This API endpoint retrieves information about a workspace.

get/v1/workspaces

Response

200

idstring

industrystring

isCompaniesEnabledboolean

isClientDirectSignUpEnabledboolean

logOutUrlstring

brandNamestring

squareIconUrlstring

fullLogoUrlstring

squareLoginImageUrlstring

socialSharingImageUrlstring

colorSidebarBackgroundstring

colorSidebarTextstring

colorAccentstring

fontstring

metaTitlestring

metaDescriptionstring

portalUrlstring

Example response

{
  "id": "us-east-1_Gz7TRlAaM",
  "industry": "finance",
  "isCompaniesEnabled": true,
  "isClientDirectSignUpEnabled": true,
  "logOutUrl": "https://portal.copilotcustomdomaintesting.online",
  "brandName": "Feature Testing",
  "squareIconUrl": "https://logo.clearbit.com/copilot.app",
  "fullLogoUrl": "https://logo.clearbit.com/copilot.app",
  "squareLoginImageUrl": "https://dopg8hpnitzl9.cloudfront.net/copilot/images/auth_image.png",
  "socialSharingImageUrl": "https://dopg8hpnitzl9.cloudfront.net/copilot/images/auth_image.png",
  "colorSidebarBackground": "#000000",
  "colorSidebarText": "#ffffff",
  "colorAccent": "#72788D",
  "font": "Inter",
  "metaTitle": "Feature Testing",
  "portalUrl": "portal.copilotcustomdomaintesting.online",
  "labels": {
    "individualTerm": "Client",
    "individualTermPlural": "Clients",
    "groupTerm": "Company",
    "groupTermPlural": "Companies"
  }
}