Themes

List all themes

Retrieve all themes in organization.

get/themes

Request

Query parameters

filter[name]string
Example:Spring Newsletter

Filter themes by name. Exact match filter.

filter[tags]string
Example:Newsletter,Outreach

Filter themes by tags. Scope match filter.

filter[published]boolean
Example:true

Filter themes by published status. Scope match filter.

sortstring
Example:created_at

Sort themes by field (created_at, updated_at).

pageinteger

Page number

per_pageinteger

Number of items per page

Response

OK

Example response

{
  "data": [
    {
      "type": "theme",
      "id": "63eff78889f21",
      "attributes": {
        "id": "63eff78889f21",
        "name": "Spring Newsletter",
        "description": "Sample description",
        "published": true,
        "tags": [
          "Newsletter",
          "Outreach"
        ],
        "created_at": "2023-05-17T21:54:19.000000Z",
        "updated_at": "2023-05-18T19:55:21.000000Z"
      }
    }
  ],
  "links": {
    "first": "https://enterprise.knak.io/api/published/v1/themes?page=1",
    "last": "https://enterprise.knak.io/api/published/v1/themes?page=3",
    "prev": "https://enterprise.knak.io/api/published/v1/themes?page=1",
    "next": "https://enterprise.knak.io/api/published/v1/themes?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": "https://enterprise.knak.io/api/published/v1/themes?page=2",
        "label": "Next",
        "active": true
      }
    ],
    "path": "https://enterprise.knak.io/api/published/v1/themes?page=2",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.