Rate this page:

Themes

Get themes

GET /wiki/rest/api/settings/theme

Returns all themes, not including the default theme.

Permissions required: None

App scope requiredREAD

OAuth scopes required
manage:confluence-configuration

Request

Query parameters
start

integer

The starting index of the returned themes.

Default: 0, Minimum: 0, Format: int32
limit

integer

The maximum number of themes to return per page. Note, this may be restricted by fixed system limits.

Default: 100, Minimum: 0, Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme' \
  --header 'Accept: application/json'

Responses

Returned if the requested themes are returned.

Content typeValue
application/json

ThemeArray

Get global theme

GET /wiki/rest/api/settings/theme/selected

Returns the globally assigned theme.

Permissions required: None

App scope requiredREAD

OAuth scopes required
manage:confluence-configuration

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme/selected' \
  --header 'Accept: application/json'

Responses

Returned if the global theme is returned.

Content typeValue
application/json

allOf [ThemeNoLinks, object]

Get theme

GET /wiki/rest/api/settings/theme/{themeKey}

Returns a theme. This includes information about the theme name, description, and icon.

Permissions required: None

App scope requiredREAD

OAuth scopes required
manage:confluence-configuration

Request

Path parameters
themeKey Required

string

The key of the theme to be returned.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/settings/theme/{themeKey}' \
  --header 'Accept: application/json'

Responses

Returned if the requested theme is returned.

Content typeValue
application/json

allOf [ThemeNoLinks, object]

Get space theme

GET /wiki/rest/api/space/{spaceKey}/theme

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.

App scope requiredREAD

OAuth scopes required
read:confluence-space.summary

Request

Path parameters
spaceKey Required

string

The key of the space to be queried for its theme.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme' \
  --header 'Accept: application/json'

Responses

Returned if the requested theme is returned.

Content typeValue
application/json

allOf [ThemeNoLinks, object]

Set space theme

PUT /wiki/rest/api/space/{spaceKey}/theme

Sets the theme for a space. Note, if you want to reset the space theme to the default Confluence theme, use the 'Reset space theme' method instead of this method.

Permissions required: 'Admin' permission for the space.

App scope requiredWRITE

OAuth scopes required
write:confluence-space

Request

Path parameters
spaceKey Required

string

The key of the space to set the theme for.

Body parameters
themeKey Required

string

The key of the theme to be set as the space theme.

Example

1
2
3
4
5
6
7
curl --request PUT \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "themeKey": "<string>"
}'

Responses

Returned if the theme was set for the space.

Content typeValue
application/json

allOf [ThemeNoLinks, object]

Reset space theme

DELETE /wiki/rest/api/space/{spaceKey}/theme

Resets the space theme. This means that the space will inherit the global look and feel settings

Permissions required: 'Admin' permission for the space.

App scope requiredDELETE

OAuth scopes required
write:confluence-space

Request

Path parameters
spaceKey Required

string

The key of the space to reset the theme for.

Example

1
2
curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/space/{spaceKey}/theme'

Responses

Returned if the theme was reset for the space.

Rate this page: