Introduction
Welcome to the LeadPages Mandrel API documentation.
This API adheres to the LeadPages HTTP API Standards document.
Endpoints
/template/v2
Ping
/template/v2/ping
A no-op endpoint that can be used to check what
the currently-deployed version of the API is.
Request
GET /template/v2/ping
Response
| Body |
|
_meta._version |
String
The current internal version number of the API. |
_meta |
Dictionary
|
Leadbars
/template/v2/leadbars
Request
GET /template/v2/leadbars
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/leadbars
Response
Leadbartemplate
/template/v2/leadbars/{uuid}
Request
GET /template/v2/leadbars/{uuid}
Response
Request
PUT /template/v2/leadbars/{uuid}
Response
Request
DELETE /template/v2/leadbars/{uuid}
Response
Previewhtml
/template/v2/leadbars/{uuid}/preview.html
Request
GET /template/v2/leadbars/{uuid}/preview.html
Response
Editions
/template/v2/leadbars/{uuid}/editions
This endpoint is used to publish the given
Leadbar.
Request
GET /template/v2/leadbars/{uuid}/editions
Enumerate all of the given Leadbar's
editions. This can be treated as a publication history for
the Leadbar.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
POST /template/v2/leadbars/{uuid}/editions
Publish a new edition of the given Leadbar.
| Body |
|
source |
Dictionary
The source JSON for the edition (i.e. a 'Page JSON' structure). |
previewOnly |
Boolean?
If this is provided and true, then the new Edition will only publish its preview to GCS, leaving its associated content unchanged. |
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/leadbars/{uuid}/editions
Delete all of the specified Leadbar's
editions. This method exists purely for convenience during
development and will be removed before general release.
Response
Sourcejson
/template/v2/leadbars/{uuid}/source.json
Request
GET /template/v2/leadbars/{uuid}/source.json
Response
Draftjson
/template/v2/leadbars/{uuid}/draft.json
Request
GET /template/v2/leadbars/{uuid}/draft.json
Response
Templatejson
/template/v2/leadbars/{uuid}/template.json
Request
GET /template/v2/leadbars/{uuid}/template.json
Response
Request
PUT /template/v2/leadbars/{uuid}/template.json
Response
Screenshot
/template/v2/leadbars/{uuid}/screenshot.png
Request
PATCH /template/v2/leadbars/{uuid}/screenshot.png
Response
Leadboxes
/template/v2/leadboxes
Request
GET /template/v2/leadboxes
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/leadboxes
Response
Leadboxtemplate
/template/v2/leadboxes/{uuid}
Request
GET /template/v2/leadboxes/{uuid}
Response
Request
PUT /template/v2/leadboxes/{uuid}
Response
Request
DELETE /template/v2/leadboxes/{uuid}
Response
Previewhtml
/template/v2/leadboxes/{uuid}/preview.html
Request
GET /template/v2/leadboxes/{uuid}/preview.html
Response
Editions
/template/v2/leadboxes/{uuid}/editions
This endpoint is used to publish the given
Leadbox.
Request
GET /template/v2/leadboxes/{uuid}/editions
Enumerate all of the given Leadbox's
editions. This can be treated as a publication history for
the Leadbox.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
POST /template/v2/leadboxes/{uuid}/editions
Publish a new edition of the given Leadbox.
| Body |
|
source |
Dictionary
The source JSON for the edition (i.e. a 'Page JSON' structure). |
previewOnly |
Boolean?
If this is provided and true, then the new Edition will only publish its preview to GCS, leaving its associated content unchanged. |
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/leadboxes/{uuid}/editions
Delete all of the specified Leadbox's
editions. This method exists purely for convenience during
development and will be removed before general release.
Response
Sourcejson
/template/v2/leadboxes/{uuid}/source.json
Request
GET /template/v2/leadboxes/{uuid}/source.json
Response
Draftjson
/template/v2/leadboxes/{uuid}/draft.json
Request
GET /template/v2/leadboxes/{uuid}/draft.json
Response
Templatejson
/template/v2/leadboxes/{uuid}/template.json
Request
GET /template/v2/leadboxes/{uuid}/template.json
Response
Request
PUT /template/v2/leadboxes/{uuid}/template.json
Response
Screenshot
/template/v2/leadboxes/{uuid}/screenshot.png
Request
PATCH /template/v2/leadboxes/{uuid}/screenshot.png
Response
Leadpages
/template/v2/leadpages
Request
GET /template/v2/leadpages
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/leadpages
Response
Leadpagetemplate
/template/v2/leadpages/{uuid}
Request
GET /template/v2/leadpages/{uuid}
Response
Request
PATCH /template/v2/leadpages/{uuid}
Response
Request
PUT /template/v2/leadpages/{uuid}
Response
Request
DELETE /template/v2/leadpages/{uuid}
Response
Editions
/template/v2/leadpages/{uuid}/editions
This endpoint is used to publish the given
Leadpage.
Request
GET /template/v2/leadpages/{uuid}/editions
Enumerate all of the given Leadpage's
editions. This can be treated as a publication history for
the Leadpage.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
POST /template/v2/leadpages/{uuid}/editions
Publish a new edition of the given Leadpage.
| Body |
|
source |
Dictionary
The source JSON for the edition (i.e. a 'Page JSON' structure). |
previewOnly |
Boolean?
If this is provided and true, then the new Edition will only publish its preview to GCS, leaving its associated content unchanged. |
children |
List?[String]
|
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/leadpages/{uuid}/editions
Delete all of the specified Leadpage's
editions. This method exists purely for convenience during
development and will be removed before general release.
Response
Children
/template/v2/leadpages/{uuid}/children
Request
GET /template/v2/leadpages/{uuid}/children
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Leadbars
/template/v2/leadpages/{uuid}/leadbars
Request
GET /template/v2/leadpages/{uuid}/leadbars
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/leadpages/{uuid}/leadbars
Response
Leadboxes
/template/v2/leadpages/{uuid}/leadboxes
Request
GET /template/v2/leadpages/{uuid}/leadboxes
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/leadpages/{uuid}/leadboxes
Response
Previewhtml
/template/v2/leadpages/{uuid}/preview.html
Request
GET /template/v2/leadpages/{uuid}/preview.html
Response
Sourcejson
/template/v2/leadpages/{uuid}/source.json
Request
GET /template/v2/leadpages/{uuid}/source.json
Response
Templatejson
/template/v2/leadpages/{uuid}/template.json
Request
GET /template/v2/leadpages/{uuid}/template.json
Response
Request
PUT /template/v2/leadpages/{uuid}/template.json
Response
Draftjson
/template/v2/leadpages/{uuid}/draft.json
Request
GET /template/v2/leadpages/{uuid}/draft.json
Response
Screenshot
/template/v2/leadpages/{uuid}/screenshot.png
Request
PATCH /template/v2/leadpages/{uuid}/screenshot.png
Response
Sites
/template/v2/sites
Request
GET /template/v2/sites
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
| Body |
|
_meta |
ListingMeta
Meta information about the response. |
_items |
List[Site]
|
Request
POST /template/v2/sites
Response
Sitetemplate
/template/v2/sites/{uuid}
Request
GET /template/v2/sites/{uuid}
Response
Request
PUT /template/v2/sites/{uuid}
Response
Request
DELETE /template/v2/sites/{uuid}
Response
Editions
/template/v2/sites/{uuid}/editions
This endpoint is used to publish the given
Site.
Request
GET /template/v2/sites/{uuid}/editions
Enumerate all of the given Site's
editions. This can be treated as a publication history for
the Site.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
POST /template/v2/sites/{uuid}/editions
Publish a new edition of the given Site.
| Body |
|
source |
Dictionary
The source JSON for the edition (i.e. a 'Page JSON' structure). |
previewOnly |
Boolean?
If this is provided and true, then the new Edition will only publish its preview to GCS, leaving its associated content unchanged. |
children |
List?[String]
|
routes |
List[SiteRoute]
|
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/sites/{uuid}/editions
Delete all of the specified Site's
editions. This method exists purely for convenience during
development and will be removed before general release.
Response
Children
/template/v2/sites/{uuid}/children
Request
GET /template/v2/sites/{uuid}/children
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Leadbars
/template/v2/sites/{uuid}/leadbars
Request
GET /template/v2/sites/{uuid}/leadbars
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/sites/{uuid}/leadbars
Response
Leadboxes
/template/v2/sites/{uuid}/leadboxes
Request
GET /template/v2/sites/{uuid}/leadboxes
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/sites/{uuid}/leadboxes
Response
Previewhtml
/template/v2/sites/{uuid}/preview.html
Request
GET /template/v2/sites/{uuid}/preview.html
Response
Sourcejson
/template/v2/sites/{uuid}/source.json
Request
GET /template/v2/sites/{uuid}/source.json
Response
Templatejson
/template/v2/sites/{uuid}/template.json
Request
GET /template/v2/sites/{uuid}/template.json
Response
Request
PUT /template/v2/sites/{uuid}/template.json
Response
Draftjson
/template/v2/sites/{uuid}/draft.json
Request
GET /template/v2/sites/{uuid}/draft.json
Response
Screenshot
/template/v2/sites/{uuid}/screenshot.png
Request
PATCH /template/v2/sites/{uuid}/screenshot.png
Response
Sections
/template/v2/sections
Request
GET /template/v2/sections
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
POST /template/v2/sections
Response
Sectiontemplate
/template/v2/sections/{uuid}
Request
GET /template/v2/sections/{uuid}
Response
Request
PATCH /template/v2/sections/{uuid}
Response
Request
PUT /template/v2/sections/{uuid}
Response
Request
DELETE /template/v2/sections/{uuid}
Response
Editions
/template/v2/sections/{uuid}/editions
This endpoint is used to publish the given
Section.
Request
GET /template/v2/sections/{uuid}/editions
Enumerate all of the given Section's
editions. This can be treated as a publication history for
the Section.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
POST /template/v2/sections/{uuid}/editions
Publish a new edition of the given Section.
| Body |
|
source |
Dictionary
The source JSON for the edition (i.e. a 'Page JSON' structure). |
previewOnly |
Boolean?
If this is provided and true, then the new Edition will only publish its preview to GCS, leaving its associated content unchanged. |
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/sections/{uuid}/editions
Delete all of the specified Section's
editions. This method exists purely for convenience during
development and will be removed before general release.
Response
Previewhtml
/template/v2/sections/{uuid}/preview.html
Request
GET /template/v2/sections/{uuid}/preview.html
Response
Sourcejson
/template/v2/sections/{uuid}/source.json
Request
GET /template/v2/sections/{uuid}/source.json
Response
Templatejson
/template/v2/sections/{uuid}/template.json
Request
GET /template/v2/sections/{uuid}/template.json
Response
Request
PUT /template/v2/sections/{uuid}/template.json
Response
Draftjson
/template/v2/sections/{uuid}/draft.json
Request
GET /template/v2/sections/{uuid}/draft.json
Response
Screenshot
/template/v2/sections/{uuid}/screenshot.png
Request
PATCH /template/v2/sections/{uuid}/screenshot.png
Response
Templates
/template/v2/templates
Request
GET /template/v2/templates
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Request
PATCH /template/v2/templates
Rebuild the index for the template listing from
scratch. This needs to be done if we ever add a new property to the
list of indexed fields. Requires Super Admin credentials, and
returns all indexed templates.
Response
Template
/template/v2/templates/{uuid}
Request
GET /template/v2/templates/{uuid}
Response
Previewhtml
/template/v2/templates/{uuid}/preview.html
Request
GET /template/v2/templates/{uuid}/preview.html
Response
Sourcejson
/template/v2/templates/{uuid}/source.json
Request
GET /template/v2/templates/{uuid}/source.json
Response
Templatejson
/template/v2/templates/{uuid}/template.json
Request
GET /template/v2/templates/{uuid}/template.json
Response
Draftjson
/template/v2/templates/{uuid}/draft.json
Request
GET /template/v2/templates/{uuid}/draft.json
Response
Editions
/template/v2/templates/{uuid}/editions
This endpoint is used to publish the given
Template.
Request
GET /template/v2/templates/{uuid}/editions
Enumerate all of the given Template's
editions. This can be treated as a publication history for
the Template.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Children
/template/v2/templates/{uuid}/children
Request
GET /template/v2/templates/{uuid}/children
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Leadbars
/template/v2/templates/{uuid}/leadbars
Request
GET /template/v2/templates/{uuid}/leadbars
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Leadboxes
/template/v2/templates/{uuid}/leadboxes
Request
GET /template/v2/templates/{uuid}/leadboxes
Enumerate all templates
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
Taxonomy
/template/v2/taxonomy
Fetch all categories/tags with labels
Request
GET /template/v2/taxonomy
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
id |
Or?[Regexp, List]
|
name |
String?
|
kind |
Or?[String, List]
|
legacy_id |
Or?[Regexp, List]
|
deleted |
Or?[DateTime, Number]
|
release_date |
Or?[DateTime, Number]
|
conversion_rate |
Number?
|
categories |
Or?[String, List]
|
tags |
Or?[String, List]
|
order_by |
Or?[String, List]
|
schema_version |
Integer?
|
allowed_groups |
String?
|
Response
| Body |
|
taxons |
List[Taxon]
The list of available taxons with the given filters. |
Editions
/template/v2/editions
Editions provide the publishing model for Foundry API.
An edition represents the publication of a given piece of Content. To
publish something, you just create a new edition of it. Editions also
provide a simple mechanism for un-publishing things, or reverting to
previously published editions.
The top level editions endpoints are considered view-only.
Request
GET /template/v2/editions
Enumerate all editions. This is probably not all
that interesting for most clients, since having a list of all
editions generally doesn't provide enough context to do anything
useful.
| Query string |
|
limit |
Regexp?(\d+)
The maximum number of items to return in the response. |
cursor |
String?
A string representing where a previous request "left off" |
Response
Request
DELETE /template/v2/editions
This method exists purely for convenience during
development and will be removed before general release.
Response
Edition
/template/v2/editions/{uuid}
This endpoint is used to get a single specific
edition by ID. You'll probably use this mainly to poll an edition's
status while publishing.
Request
GET /template/v2/editions/{uuid}
Response
| Body |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
Request
DELETE /template/v2/editions/{uuid}
This method will most likely be removed prior
to general release.
Response
Sourcejson
/template/v2/editions/{uuid}/source.json
Request
GET /template/v2/editions/{uuid}/source.json
Response
| Errors |
|
404 Not Found |
source for edition '{}' not found |
Templatejson
/template/v2/editions/{uuid}/template.json
Request
GET /template/v2/editions/{uuid}/template.json
Response
Screenshot
/template/v2/editions/{uuid}/screenshot.png
Request
GET /template/v2/editions/{uuid}/screenshot.png
Response
| Errors |
|
404 Not Found |
screenshot for edition '{}' not found |
Previewhtml
/template/v2/editions/{uuid}/preview.html
Request
GET /template/v2/editions/{uuid}/preview.html
Response
| Errors |
|
404 Not Found |
preview for edition '{}' not found |
Definitions
| ListingMeta |
|
limit |
Integer
The requested limit on the number of items. |
total |
Integer?
The number of items in the database. |
count |
Integer
The total number of items in the response. |
cursor |
String?
This is used in conjunction with limit to paginate through lists of items. |
Edition
| Edition |
|
_meta |
Meta
Meta information about the resource. |
template |
String
The UUID of the template resource to which the edition belongs. |
status |
Enum('pending', 'failure', 'success')
The status of the edition's publication. This is not an indication of whether or not the edition is currently published, but the status of its initial publication. |
previewUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
screenshotUrl |
URI?
The public URL to which the preview was published. Only available for Editions created with previewOnly set to true. |
tags |
List[String]
|
children |
List?[String]
|
routes |
List?[SiteRoute]
|
editor |
Email?
|
| Meta |
|
id |
String
The resource's unique identifier. |
uri |
String
The resource's absolute URI. |
created |
DateTime
When the resource was created. |
updated |
DateTime
When the resource was last updated. |
SiteRoute
| SiteRoute |
|
slug |
String
A URL-safe string used as the public path for the route. |
id |
String
The ID for the route. |
LeadbarTemplate
| LeadbarTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
previewUrl |
URI?
|
thumbnailUrl |
URI?
|
thumbnailUrlWebp |
URI?
|
fullPageScreenshotUrlWebp |
URI?
|
thumbnailAspect |
Number?
|
parent |
String?
|
LeadboxTemplate
| LeadboxTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
previewUrl |
URI?
|
thumbnailUrl |
URI?
|
thumbnailUrlWebp |
URI?
|
fullPageScreenshotUrlWebp |
URI?
|
thumbnailAspect |
Number?
|
parent |
String?
|
LeadpageTemplate
| LeadpageTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
previewUrl |
URI?
|
thumbnailUrl |
URI?
|
thumbnailUrlWebp |
URI?
|
fullPageScreenshotUrlWebp |
URI?
|
thumbnailAspect |
Number?
|
legacyId |
String?
|
SectionTemplate
| SectionTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
previewUrl |
URI?
|
thumbnailUrl |
URI?
|
thumbnailUrlWebp |
URI?
|
fullPageScreenshotUrlWebp |
URI?
|
thumbnailAspect |
Number?
|
SiteTemplate
| SiteTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
previewUrl |
URI?
|
thumbnailUrl |
URI?
|
thumbnailUrlWebp |
URI?
|
fullPageScreenshotUrlWebp |
URI?
|
thumbnailAspect |
Number?
|
CreateLeadbarTemplate
| CreateLeadbarTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
sourceId |
String?
|
sourceEdition |
String?
|
parent |
String?
|
Leadbar
| Leadbar |
|
_meta |
Meta
Meta information about the resource. |
kind |
Enum('LeadbarTemplate')
|
template |
LeadbarTemplate
|
CreateLeadboxTemplate
| CreateLeadboxTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
sourceId |
String?
|
sourceEdition |
String?
|
parent |
String?
|
Leadbox
| Leadbox |
|
_meta |
Meta
Meta information about the resource. |
kind |
Enum('LeadboxTemplate')
|
template |
LeadboxTemplate
|
Template
CreateLeadpageTemplate
| CreateLeadpageTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
sourceId |
String?
|
sourceEdition |
String?
|
legacyId |
String?
|
Leadpage
| Leadpage |
|
_meta |
Meta
Meta information about the resource. |
kind |
Enum('LeadpageTemplate')
|
template |
LeadpageTemplate
|
CreateSiteTemplate
| CreateSiteTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
sourceId |
String?
|
sourceEdition |
String?
|
Site
| Site |
|
_meta |
Meta
Meta information about the resource. |
kind |
Enum('SiteTemplate')
|
template |
SiteTemplate
|
CreateSectionTemplate
| CreateSectionTemplate |
|
name |
String
|
conversionRate |
Number?
|
uses |
Number?
|
tags |
List?[String]
|
categories |
List?[String]
|
releaseDate |
DateTime?
|
sortKey |
Integer?(0 < n < 999999)
|
enabled |
Boolean
Whether or not the template is visible to normal users. |
bundles |
List?[Regexp]
|
currentEdition |
String?
|
sourceId |
String?
|
sourceEdition |
String?
|
Section
| Section |
|
_meta |
Meta
Meta information about the resource. |
kind |
Enum('SectionTemplate')
|
template |
SectionTemplate
|
Taxon
| Taxon |
|
label |
String
A human-friendly label for the taxon, suitable for showing to end users. |
value |
String
The underlying value for the taxon, which should be used when constructing filters. |
collection |
Enum('categories', 'tags', 'id')
The underlying property for the taxon, on which one would filter for the relevant value. |
section |
Enum('Content', 'Industries', 'Collections', 'Layouts', 'Page Elements', 'Page Types', 'Section Types', 'Templates')
If segregating taxons into logical groups, the human-friendly title for the section to which the taxon belongs |
count |
Integer?
The number of templates matching all applied filters and and this taxon. |
