Skip to main content
GET
Get a single workflow

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 workflow.

Example:

123

Response

OK

A workflow owned by, or shared with, the authenticated user.

id
integer
required

ID of the workflow.

Example:

123

latest_revision_id
integer
required

ID of the latest revision, the one to edit.

Example:

789

name
string
required

Name of the workflow.

Example:

"My Workflow"

owner
object
required

The user who owns the workflow.

deployed_revision_id
integer | null

ID of the currently deployed revision, or null when the workflow is not deployed.

Example:

788

description
string | null

Description of the workflow, or null if it has none.

Example:

"Workflow created via API"

folder_id
integer | null

ID of the folder holding the workflow, or null for the root folder.

Example:

45

inserted_at
string<date-time>

When the workflow was created.

Example:

"2026-01-15T09:30:00.000000Z"

updated_at
string<date-time>

When the workflow was last changed.

Example:

"2026-01-15T09:30:00.000000Z"

url
string<uri>

Direct link to the entity in the Orchestrator UI.

Example:

"https://eu.phrase.com/orchestrator/manage/workflows/123/editor/789"

webhook_url
string<uri> | null

URL to POST events to in order to start the workflow, or null when no revision has used a webhook trigger. New revisions keep the same URL, but it changes if the webhook key is regenerated in the editor. It accepts events only while the deployed revision has a webhook trigger.

Example:

"https://eu.phrase.com/orchestrator/webhooks/0b7e7c1c-3f4a-4d0e-9b8f-5a2d6c9e1f30"