Get workflow
curl --request GET \
--url https://beta.getsales.io/playtables/v1/api/workflows/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Team-SID': '<api-key>'}
};
fetch('https://beta.getsales.io/playtables/v1/api/workflows/{sid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://beta.getsales.io/playtables/v1/api/workflows/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://beta.getsales.io/playtables/v1/api/workflows/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/workflows/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "get",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"description": "<string>",
"status": "draft",
"published_version_sid": "<string>",
"draft_steps": [
{
"type": "linkedin_send_connection_request",
"id": 2,
"name": "<string>",
"message": "<string>",
"required_fields": {
"refs": [
"<string>"
],
"on_missing": "fail"
}
}
],
"schedule": {
"timeblocks": [
{
"dow": 3,
"start_minute": 719,
"end_minute": 720
}
],
"timezone": "<string>",
"use_people_timezone": true
},
"on_reply": "autopilot",
"agent_sid": "<string>",
"sender_profile_sids": [
"<string>"
],
"rotation_strategy": "fair",
"priority": 123,
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {
"published_version": {
"sid": "<string>",
"workflow_sid": "<string>",
"version": 123,
"steps": [
{
"type": "linkedin_send_connection_request",
"id": 2,
"name": "<string>",
"message": "<string>",
"required_fields": {
"refs": [
"<string>"
],
"on_missing": "fail"
}
}
],
"steps_count": 123,
"entry_step_id": 123,
"created_at": "<string>"
},
"sources": [
{
"sid": "<string>"
}
],
"records_counts": {
"total_count": 1,
"groups": {
"status": {}
}
},
"forecast": {
"scheduled_count": 1,
"sender_profiles_count": 1,
"days_to_drain": 1,
"drains_on": "<string>",
"over_horizon": true,
"buckets": [
{
"sender_profile_sid": "<string>",
"type": "<string>",
"scheduled_count": 1,
"daily_share": 1,
"days_to_drain": 1,
"over_horizon": true
}
],
"timeline": [
{
"day": "<string>",
"planned": 1,
"by_type": {}
}
]
}
},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}workflows
Get workflow
Fetch one workflow by sid - the editor-open call. draft_steps rides the item; include published_version to diff draft vs live, records_counts for the header funnel.
Contract:
- MCP tool
get_workflow, registry packagemcp.playtables/workflows, mountplaytables.workflows. - Operation
get, response envelopeget. - Flags: read only.
GET
/
api
/
workflows
/
{sid}
Get workflow
curl --request GET \
--url https://beta.getsales.io/playtables/v1/api/workflows/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Team-SID: <api-key>'import requests
url = "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Team-SID': '<api-key>'}
};
fetch('https://beta.getsales.io/playtables/v1/api/workflows/{sid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://beta.getsales.io/playtables/v1/api/workflows/{sid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://beta.getsales.io/playtables/v1/api/workflows/{sid}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://beta.getsales.io/playtables/v1/api/workflows/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/playtables/v1/api/workflows/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "get",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"name": "<string>",
"description": "<string>",
"status": "draft",
"published_version_sid": "<string>",
"draft_steps": [
{
"type": "linkedin_send_connection_request",
"id": 2,
"name": "<string>",
"message": "<string>",
"required_fields": {
"refs": [
"<string>"
],
"on_missing": "fail"
}
}
],
"schedule": {
"timeblocks": [
{
"dow": 3,
"start_minute": 719,
"end_minute": 720
}
],
"timezone": "<string>",
"use_people_timezone": true
},
"on_reply": "autopilot",
"agent_sid": "<string>",
"sender_profile_sids": [
"<string>"
],
"rotation_strategy": "fair",
"priority": 123,
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {
"published_version": {
"sid": "<string>",
"workflow_sid": "<string>",
"version": 123,
"steps": [
{
"type": "linkedin_send_connection_request",
"id": 2,
"name": "<string>",
"message": "<string>",
"required_fields": {
"refs": [
"<string>"
],
"on_missing": "fail"
}
}
],
"steps_count": 123,
"entry_step_id": 123,
"created_at": "<string>"
},
"sources": [
{
"sid": "<string>"
}
],
"records_counts": {
"total_count": 1,
"groups": {
"status": {}
}
},
"forecast": {
"scheduled_count": 1,
"sender_profiles_count": 1,
"days_to_drain": 1,
"drains_on": "<string>",
"over_horizon": true,
"buckets": [
{
"sender_profile_sid": "<string>",
"type": "<string>",
"scheduled_count": 1,
"daily_share": 1,
"days_to_drain": 1,
"over_horizon": true
}
],
"timeline": [
{
"day": "<string>",
"planned": 1,
"by_type": {}
}
]
}
},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Path Parameters
The wf_wf_* sid of the row to read.
Required string length:
18Pattern:
^wf_wf_Query Parameters
Relations to attach to the row; omit for the bare row.
Available options:
published_version, sources, records_counts, step_stats, forecast