List All Variants

Changed on

Retrieve all variants across all channels for a template. Returns variant metadata and conditions; variant content is included only when include_content=true is passed.

get/v2/{workspace}/template/{template_slug}/variant/

Request

Path parameters

workspacestring required

Workspace slug.

template_slugstring required

Template slug.

Query parameters

include_contentboolean

Set to true to include each variant's content, errors and vendor_approvals in the response.

Response

Successfully retrieved variants

Example response

{
  "results": [
    {
      "$schema": "https://schema.suprsend.com/template/v2/variant_schema.json",
      "channel": "email",
      "id": "default",
      "locale": "en"
    }
  ]
}

Changes

    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 404

    • warning

      added the new added enum value to the // response property for the response status

    • warning

      added the new deleted enum value to the // response property for the response status

    • warning

      added the new discarded enum value to the // response property for the response status

    • warning

      added the new unchanged enum value to the // response property for the response status

    • warning

      added the new updated enum value to the // response property for the response status

    • warning

      added the new upload_failed enum value to the // response property for the response status

    • info

      added the new optional query request parameter include_content