Skip to content

Function: getSpaceTheme()

ts
function getSpaceTheme(client, parameters): Promise<{
[key: string]: unknown;
  _links?: {
   [key: string]: unknown;
     base?: string;
     byOperation?: string;
     collection?: string;
     context?: string;
     download?: string;
     editui?: string;
     edituiv2?: string;
     next?: string;
     prev?: string;
     self?: string;
     tinyui?: string;
     webui?: string;
  };
  description?: string;
  icon?: {
   [key: string]: unknown;
     height: number;
     isDefault: boolean;
     path: string;
     width: number;
  };
  name?: string;
  themeKey: string;
}>;

Defined in: src/v1/api/themes.ts:65

Returns the theme selected for a space, if one is set. If no space theme is set, this means that the space is inheriting the global look and feel settings.

Permissions required: ‘View’ permission for the space.

Parameters

ParameterTypeDescription
clientClient-
parameters{ spaceKey: string; }-
parameters.spaceKeystringThe key of the space to be queried for its theme.

Returns

Promise&lt;{ [key: string]: unknown; _links?: { [key: string]: unknown; base?: string; byOperation?: string; collection?: string; context?: string; download?: string; editui?: string; edituiv2?: string; next?: string; prev?: string; self?: string; tinyui?: string; webui?: string; }; description?: string; icon?: { [key: string]: unknown; height: number; isDefault: boolean; path: string; width: number; }; name?: string; themeKey: string; }>