Skip to content
Documentation

List Dynamic Content Profiles

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

Retrieves the dynamic content profiles for the currently logged in user.

Authorizations

Section titled “Authorizations”
  • OAuth2
    dynamic_content_profiles:read

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
string
name
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
organization_id
required
integer
template_engine_preset

Optional. Stable key identifying the template engine preset applied to this profile’s conditional syntax.

string
nullable
template_engine_preset_schema
required

Capability manifest describing the joiners, operators, and branch options allowed by this profile’s template engine preset. Null when no preset is set.

object
joiners
required

Supported joiner strings between conditions within a branch (e.g. “and”, “or”). Empty disallows compound conditions.

Array<string>
operators_by_type
required

Map of value type (“string”, “number”, “boolean”) to the operators allowed for that type. Each operator declares whether it takes a value, so the UI picker knows whether to render a value input.

object
key
additional properties
Array<object>
object
key
required

Wire identifier for the operator (e.g. “equals”, “is_empty”).

string
requires_value
required

Whether this operator takes a value. When false, the UI picker hides the value input and the wire payload omits value.

boolean
pagination
required
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": "uuid TODO",
      "name": "Mailchimp Profile",
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "organization_id": 12345,
      "template_engine_preset": "liquid",
      "template_engine_preset_schema": {
        "joiners": [
          "and",
          "or"
        ],
        "operators_by_type": {
          "string": [
            {
              "key": "equals",
              "requires_value": true
            },
            {
              "key": "is_empty",
              "requires_value": false
            }
          ],
          "boolean": [
            {
              "key": "equals",
              "requires_value": true
            }
          ]
        }
      }
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}