Get workspace details

Returns comprehensive information about the current workspace, including branding settings, features, and configuration. The workspace is the top-level organizational unit in Leadtime that contains all users, projects, tasks, and other entities. This endpoint provides essential workspace metadata such as company name, domain, enabled features, appearance settings (colors, logos), custom icons, sprint configuration, and billing status. User-specific data is excluded from this response and is available via the /users/me endpoint. The attendanceEnabled field is only true if attendance tracking is enabled for the workspace AND the current user is an Employee type. The isBillingLocked field indicates whether the workspace is locked due to past due billing status.

GET/workspace/details

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200

attendanceEnabledbooleanrequired

Indicates whether attendance tracking (clock in/out) is enabled for the workspace AND the current user is an Employee type. This field is false if attendance is disabled or if the current user is not an Employee.

brandingobjectrequired

Workspace branding settings including custom brand color. The brandColor field (if set) is a HEX color code that matches the company brand and is used for internal projects in various views of the application.

companyNamestringrequired

Company or organization name associated with the workspace. This is the display name shown throughout the application.

customIconsstring[]required

Array of custom icons available in the workspace. Custom icons are user-uploaded images (PNG or SVG) that can be used to visually tag tickets, projects, documents, or other entities. Each icon has a unique name (e.g., ":team_sales:") and an associated image file ID.

domainstringrequired

Workspace domain/subdomain identifier. Used in workspace URLs and API routing.

featuresstring[]required

Array of all enabled workspace features. Includes both currently active features and features that are still available but not yet activated. Features define what functionality is available in the workspace.

idstringrequired

Unique identifier for the workspace. Used to reference the workspace in other API endpoints.

isBillingLockedbooleanrequired

Indicates whether the workspace is locked due to past due billing status. When true, certain workspace operations may be restricted until billing issues are resolved.

isHelpdeskEnabledbooleanrequired

Indicates whether the helpdesk feature is enabled for the workspace. When enabled, the workspace can use ticket-based support workflows.

logoDarkThemeUrlobject | nullrequired

Public URL for the workspace logo image used in dark mode. This logo appears when users have dark theme enabled. Null if no dark theme logo has been uploaded. Recommended format: PNG with transparent background, ideal size 1000x260 pixels.

logoUrlobject | nullrequired

Public URL for the workspace logo image used in light mode. This logo appears in the top left corner of the workspace above the navigation. Null if no logo has been uploaded. Recommended format: PNG with transparent background, ideal size 1000x260 pixels.

mainWorkspaceColorstringrequired

Main accent color theme for the workspace interface. Options include Default, Black, Red, Pink, Magenta, Green, Blue, Yellow, Purple. This color affects navigation elements, buttons, and active states throughout the application.

Allowed:DEFAULTBLACKREDROSEMAGENTAGREENBLUESKYYELLOWVIOLET

navigationAnimationsEnabledbooleanrequired

Workspace default for left-right page navigation animations. Off by default. Individual users can override this in their profile.

sprintPeriodDaysnumberrequired

Duration of sprint/pipeline periods in days. Typically 7 (one week) or 14 (two weeks). Defines the time span for capacity planning in the pipeline view.

sprintStartDaynumberrequired

Day of the week when sprints/pipeline periods start. 1 = Monday, 2 = Tuesday, ..., 7 = Sunday. Used for capacity planning and pipeline views.

workspaceLanguagestringrequired

Default language code for the workspace (e.g., "en" for English, "de" for German). This setting applies to new users; individual users can override this in their profile settings.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

404

Workspace not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Request

curl -X GET "https://leadtime.app/api/public/workspace/details" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/workspace/details", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/workspace/details",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "attendanceEnabled": false,
  "branding": {},
  "companyName": "Acme Corp",
  "customIcons": [
    "string"
  ],
  "domain": "company-domain",
  "features": [
    "HELPDESK"
  ],
  "id": "workspace_456",
  "isBillingLocked": false,
  "isHelpdeskEnabled": true,
  "logoDarkThemeUrl": "https://app.example.com/api/files/public/logo_dark_456",
  "logoUrl": "https://app.example.com/api/files/public/logo_123",
  "mainWorkspaceColor": "DEFAULT",
  "navigationAnimationsEnabled": false,
  "sprintPeriodDays": 14,
  "sprintStartDay": 1,
  "workspaceLanguage": "en"
}