Scale API | Themes › List Themes

Themes

themes

Methods

Create Theme ->

Theme

post/v4/themes

Description

Custom chat themes

List Themes -> PageResponse<

Theme

get/v4/themes

Description

Lists all themes accessible to the user.

Details

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.

Security

API Key Header

Example: x-api-key: My API Key

Parameters

account_id: string

Optional

include_archived: boolean

Optional

limit: number

Optional

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

page: number

Optional

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

Response fields

PaginatedThemes

Request example

curl https://api.egp.scale.com/v4/themes \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "current_page": 0,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_user_id": "created_by_user_id",
      "logo_blob": "logo_blob",
      "theme_vars": {
        "accentPrimary": "accentPrimary",
        "accentSecondary": "accentSecondary",
        "background": "background",
        "foreground": "foreground"
      },
      "title": "title",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "archived_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "items_per_page": 0,
  "total_item_count": 0
}

Get Theme ->

Theme

get/v4/themes/{theme_id}

Description

Gets the details of a theme

Details

This API can be used to get information about a single theme by ID. To use this API, pass in the id that was returned from your Create Theme API call as a path parameter.

Review the response schema to see the fields that will be returned.

Domain types

PaginatedThemes = { current_page, items, items_per_page, 1 more... }

Theme = { id, account_id, created_at, 6 more... }