Skip to main content
GET
List duplicatable component summaries

Authorizations

Authorization
string
header
required

Query Parameters

name
string

The name of the component to filter by. Without * it must equal the whole name. Put * at the start, the end, or both to match names that end with, start with, or contain the rest.

source_client_id
string

A comma-separated list of source client ids; Only components with specified source client ids will be returned.

state
string

The state of the components campaign to filter by. (LIVE, PAUSED, ENDED,...)

version_state
enum<string>

The version state of the components campaign to filter by.

Available options:
LATEST,
PUBLISHED
campaign_ids
string

A comma-separated list of components campaign IDs to filter by.

having_any_tags
string

A comma-separated list of tags; the component must have at least one of these tags.

having_all_tags
string

A comma-separated list of tags; the component must have all of these tags.

exclude_having_any_tags
string

A comma-separated list of tags; the component having any of these tags is excluded.

exclude_having_all_tags
string

A comma-separated list of tags; the component having all of these tags is excluded.

having_any_types
string

A comma-separated list of component types; the component must have at least one of these types.

having_all_types
string

A comma-separated list of component types; the component must have all of these types.

having_any_settings
string

A comma-separated list of setting name:value pairs. Backslash escapes the next character (e.g. , : \). The component must have at least one.

having_all_settings
string

A comma-separated list of setting name:value pairs. Backslash escapes the next character (e.g. , : \). The component must have all of them.

target_component_id
string

The ID of the target component to filter by. Only compatible components will be returned.

target_setting_name
string

The name of the target setting (socket or component_setting_lookup) to filter by. Only compatible components will be returned.

target_setting_filter_collection
string

The REST-visible property name on the resolved target setting whose value provides the compatibility filter collection. When provided explicitly, it requires target_component_id and target_setting_name. Defaults to filters when omitted. Only REST-visible properties whose values are supported filter collections are accepted. Only compatible components will be returned.

show_all
boolean

showAll applies only for components visible due components subscriptionsfalse (default) shows components from LIVE, integration and campaign-components program-types.true returns all components regardless of their program-type or state of the campaign.

limit
integer<int32>
default:1000

The maximum number of components to return.

offset
integer<int32>
default:0

The number of components to skip before the first one returned.

Response

Successful response

campaign_id
string
required

The campaign that holds the component. For a root component, pass it to POST /v2/campaigns/{campaignId}/duplicate to copy the whole campaign.

campaign_state
enum<string>
required

The state of the campaign that holds the component.

Available options:
ARCHIVED,
ENDED,
LIVE,
NOT_LAUNCHED,
PAUSED,
STOPPED
description
string
required

What the component is for, as its author wrote it.

display_name
string
required

The component's display name, after buildtime evaluation. The root component of a campaign takes the campaign's name when it has no display name of its own.

id
string
required
read-only

The component's id. Pass it to POST /v1/components/{component_id}/duplicate to copy the component.

name
string
required

The component's name. The root component of every campaign has the name root.

owner
enum<string>
required

Who owns the component. EXTOLE and EXTOLE_BETA are components that Extole provides, such as the campaign templates. CLIENT is a component of the calling client or of a client that shares it.

Available options:
CLIENT,
EXTOLE,
EXTOLE_BETA
source_client_id
string
required

The id of the client that holds the component.

tags
string[]
required

The tags on the component.

types
string[]
required

The component's types. The root component of a Flow Builder campaign has the type campaign-v10.0.

version
integer<int32>
required

The version of the component that the row describes.