Skip to main content
GET
Get a single template

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

id
integer
required

ID of the template.

Example:

7

Response

OK

Detailed information about a single published workflow template.

id
integer
required

Unique identifier of the template.

Example:

7

providers
enum<string>[]
required

Products the template integrates with.

Available options:
strings,
tms,
orchestrator,
slack,
welocalize,
taus,
vistatec,
custom
tags
string[]
required

Tags the template is categorized under.

title
string
required

Human-readable name of the template.

Example:

"Notify Slack when a job completes"

description
string | null

What the workflow built from this template does. Empty if the template has no description. May contain HTML.

Example:

"Posts a Slack message whenever a TMS job reaches the completed status."

difficulty_level
enum<string> | null

How much setup the template requires, or null if not set.

Available options:
beginner,
intermediate,
advanced
Example:

"beginner"

teaser_text
string | null

Short one-line summary of the template, or null if it has none.

Example:

"Keep your team posted on finished translation jobs."

url
string<uri>

Direct link to the entity in the Orchestrator UI.

Example:

"https://eu.phrase.com/orchestrator/admin/templates/7"

value_proposition
string | null

Longer explanation of the value the template delivers. Empty if the template has none. May contain HTML.

Example:

"Removes the manual status check by pushing job completions straight into Slack."

image_url
string | null

URL of the template's illustration, or null if it has none.

Example:

"https://assets.phrase.com/orchestrator/templates/slack-job-completed.png"

workflow_definition
WorkflowDefinition · object

Orchestrator workflow definition.

Example: