GET
/
v4
/
themes
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const theme of client.themes.list()) {
  console.log(theme.id);
}
{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "theme_vars": {
        "accentPrimary": "<string>",
        "accentSecondary": "<string>",
        "background": "<string>",
        "foreground": "<string>"
      },
      "logo_blob": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "archived_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "<string>",
      "account_id": "<string>"
    }
  ],
  "total_item_count": 123,
  "current_page": 123,
  "items_per_page": 123
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string

Query Parameters

​
page
integer
default:1

Page number for pagination to be returned by the given endpoint. Starts at page 1

Required range: x >= 1
​
limit
integer
default:100

Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.

Required range: 1 <= x <= 10000
​
account_id
string
​
include_archived
boolean
default:false

Response

200
application/json

Successful Response

The response is of type object.