Workspace

Get Workspace

Retrieve basic information about the authenticated workspace — name, industry, country, currency, timezone, and about blurb. Use this endpoint when you need to present context about the user's business.

GET /api/v1/workspace

Required Scope: workspace:read

curl https://app.bluesuite.com/api/v1/workspace \
  -H "Authorization: Bearer wk_YOUR_API_KEY"

{
  "success": true,
  "data": {
    "id": 42,
    "name": "Rivera Plumbing",
    "slug": "rivera-plumbing",
    "industry": "Plumbing",
    "industry_key": "plumbing",
    "country": "US",
    "currency": "usd",
    "timezone": "America/Chicago",
    "about": "Family-owned plumbing service in Austin, TX."
  }
}

Response Fields:

Field	Type	Description
`id`	integer	Workspace ID
`name`	string	Workspace display name
`slug`	string	URL slug
`industry`	string \| null	Human-readable industry label
`industry_key`	string \| null	Machine-readable industry key
`country`	string \| null	ISO country code
`currency`	string \| null	Lowercase ISO currency code
`timezone`	string \| null	IANA timezone name
`about`	string \| null	Short description of the workspace

Get Workspace

On this page