Skip to main content
GET
/
v4
/
themes
/
{theme_id}
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const theme = await client.themes.retrieve('theme_id');

console.log(theme.id);
{
  "id": "<string>",
  "title": "<string>",
  "theme_vars": {
    "accentPrimary": "<string>",
    "accentSecondary": "<string>",
    "background": "<string>",
    "foreground": "<string>"
  },
  "logo_blob": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "account_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
theme_id
string
required

Response

Successful Response

​
id
string
required
​
title
string
required
​
theme_vars
ThemeVars · object
required
​
logo_blob
string
required
​
created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

​
updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

​
created_by_user_id
string
required

The user who originally created the entity.

​
created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
​
account_id
string
required

The ID of the account that owns the given entity.

​
archived_at
string<date-time>

The date and time when the entity was archived in ISO format.