Skip to content
Documentation

List Conditionals

GET
/api/v1/workspaces/{workspace_id}/conditionals
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/conditionals?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

Retrieves the conditionals.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
results
required
Array<object>
object
id
required
integer
label
required
string
default_syntax
required
object
closing
required

The closing syntax tag for the conditional block.

string
branch_values

Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object
key
additional properties
string
branches
required
Array<object>
object
key
required
string
label
required
string
can_be_used_in_subject_and_preheader
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time
organization_id
required
integer
dynamic_content_profile_syntaxes
required
object
key
additional properties

A per-DynamicContentProfile syntax entry on a Conditional. Either a manually-authored {closing, branch_values} pair or a picker-authored {uses_ui_picker, ui_picker_state} pair — the two modes are mutually exclusive.

object
closing

Manual mode only. The closing syntax tag for the conditional block.

string
branch_values

Manual mode only. Key-value pairs where the key is the branch key and the value is the opening syntax for that branch.

object
key
additional properties
string
uses_ui_picker

When true, the syntax for this dynamic content profile was authored via the UI picker for the profile’s template engine preset. When false or absent, it was defined manually.

boolean
ui_picker_state

Authored picker state when uses_ui_picker is true. Null or absent otherwise. The template engine preset renders this into {closing, branch_values} on read.

object
include_else_branch
required

When true, the final branch of the parent Conditional is rendered as an else branch and its key is omitted from branches below.

boolean
branches
required

Picker state keyed by branch key. Includes one entry per non-else branch; when include_else_branch is true the final branch key is omitted.

object
key
additional properties

Picker-authored state for a single non-else branch of a conditional.

object
joiner
required

How multiple conditions combine (e.g. “and”, “or”). Always present for a stable shape; only semantically meaningful when conditions has more than one entry. Must be one of the joiners allowed by the preset — see template_engine_preset_schema.joiners.

string
conditions
required

Conditions that must all (or any, depending on joiner) hold for this branch to match. At least one entry required.

Array<object>
>= 1 items

A single condition within a picker branch. Validated server-side against the profile’s template engine preset capabilities.

object
field
required

The reference the template engine reads when evaluating this condition (e.g. “profile.tier”).

string
type
required

Declared value type. Drives the allowed operators and the shape of value.

string
Allowed values: string number boolean
operator
required

One of the operators the preset allows for the declared type. See template_engine_preset_schema.operators_by_type[type] on the associated DynamicContentProfile.

string
value

The value being compared against. Always a string on the wire; the preset renderer decides how to format it based on type (quoted for “string”, raw for “number”/“boolean”). Required when the operator’s definition has requires_value=true; null (or absent) when requires_value=false.

string
nullable
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "label": "Over age 30s",
      "default_syntax": {
        "closing": "{% endif %}",
        "branch_values": {
          "gold_membership": "{% if membership == 'gold' %}",
          "silver_membership": "{% elsif membership == 'silver' %}"
        }
      },
      "branches": [
        {
          "key": "gold_membership",
          "label": "Gold Membership"
        }
      ],
      "can_be_used_in_subject_and_preheader": false,
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "organization_id": 12345,
      "dynamic_content_profile_syntaxes": {
        "additionalProperty": {
          "closing": "{% endif %}",
          "branch_values": {
            "gold_membership": "{% if membership == 'gold' %}",
            "silver_membership": "{% elsif membership == 'silver' %}"
          },
          "uses_ui_picker": false,
          "ui_picker_state": {
            "include_else_branch": false,
            "branches": {
              "gold": {
                "joiner": "and",
                "conditions": [
                  {
                    "field": "profile.tier",
                    "type": "string",
                    "operator": "equals",
                    "value": "gold"
                  }
                ]
              }
            }
          }
        }
      }
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}