Skip to main content
GET
/
workflow-service
/
api
/
public
/
v1
/
workflows
/
{workflowId}
Get Workflow
curl --request GET \
  --url https://api.slatehq.ai/workflow-service/api/public/v1/workflows/{workflowId} \
  --header 'Authorization: <authorization>'
{
  "_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "uuid": "<string>",
  "categories": [
    "<string>"
  ],
  "defaultVersion": 123,
  "totalVersions": 123,
  "inputSchema": [
    {
      "id": "<string>",
      "type": "<string>",
      "label": "<string>",
      "variableName": "<string>",
      "required": true
    }
  ],
  "outputType": "<string>",
  "emoji": "<string>",
  "color": "<string>",
  "readme": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://slatehq.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Returns full details for a single workflow, including its input schema if the workflow has been published.

Parameters

workflowId
string
required
Unique identifier for the workflow. This is the _id value returned by the List Workflows endpoint.
Authorization
string
required
Bearer token. Format: Bearer slat_<your-token>.

Response

Returns 200 OK with the workflow details.
_id
string
required
Unique identifier for the workflow.
name
string
required
Display name of the workflow.
description
string
Description of what the workflow does.
status
string
required
Current status. One of: draft, published.
uuid
string
required
Unique UUID for the workflow.
categories
string[]
Tags assigned to the workflow.
defaultVersion
number
required
The active published version number. 0 if no version has been published.
totalVersions
number
required
Total number of published versions.
inputSchema
object[]
Input fields required to run the workflow. Only present for published workflows. Each object describes one input parameter.
outputType
string
Type of output the workflow produces. Only present for published workflows.
emoji
string
Emoji icon for the workflow.
color
string
Color label for the workflow.
readme
string
Documentation or notes for the workflow.
createdAt
string
required
Timestamp when the workflow was created. ISO 8601 format.
updatedAt
string
required
Timestamp of the last update. ISO 8601 format.

Example

curl -s "https://api.slatehq.ai/workflow-service/api/public/v1/workflows/6789abc0def1234567890abc" \
  -H "Authorization: Bearer slat_YOUR_TOKEN"

Response

{
  "_id": "6789abc0def1234567890abc",
  "name": "SEO Content Generator",
  "description": "Generates SEO-optimized blog posts from a brand domain.",
  "status": "published",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "categories": ["content", "seo"],
  "defaultVersion": 3,
  "totalVersions": 3,
  "inputSchema": [
    {
      "id": "input_1",
      "type": "text",
      "label": "Brand Domain",
      "variableName": "brandDomain",
      "required": true
    },
    {
      "id": "input_2",
      "type": "text",
      "label": "Target Keywords",
      "variableName": "targetKeywords",
      "required": false
    }
  ],
  "outputType": "document",
  "emoji": "",
  "color": "blue",
  "readme": "",
  "createdAt": "2026-01-10T08:30:00.000Z",
  "updatedAt": "2026-01-25T14:15:00.000Z"
}
Use the inputSchema to discover what inputs to pass when creating a workflow run. The variableName field maps directly to the keys in the inputs object.

Status codes

StatusDescription
200Workflow found. Returns the full workflow details.
401Missing or invalid Bearer token. See Authentication.
404Workflow not found. The ID does not exist or does not belong to this workspace.
500Internal server error.

What’s next