import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// 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",
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Lists all themes accessible to the user.
This API can be used to list themes. If a user has access to multiple accounts, all themes from all accounts the user is associated with will be returned.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// 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",
"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"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000Successful Response
The data returned for the current page.
Show child attributes
The date and time when the entity was created in ISO format.
The date and time when the entity was last updated in ISO format.
The user who originally created the entity.
The type of identity that created the entity.
user, service_account The ID of the account that owns the given entity.
The date and time when the entity was archived in ISO format.
The total number of items of the query
The current page number.
The number of items per page.