cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.workflows.get_workflow("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.workflows.getWorkflow('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->workflows->getWorkflow('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.workflows.workflows_dto.WorkflowsDto.WorkflowView;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<WorkflowView> response = client.workflows().getWorkflow("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Workflows.GetWorkflowAsync("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.workflows.getWorkflow(
'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Workflows().GetWorkflow(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"workflow": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"code": "<unknown>",
"name": "<string>",
"display_name": "<string>",
"description": "<unknown>",
"entity": "<string>",
"entity_id": 123,
"event": "<string>",
"is_pre_built": true,
"enable_stage": true,
"current_version": {
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": "<unknown>",
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"href": "<string>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Workflows
Retrieve a workflow
Retrieves one workflow by its wf_ id or its code.
GET
/
workflows
/
{workflow_id}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.workflows.get_workflow("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.workflows.getWorkflow('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->workflows->getWorkflow('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.workflows.workflows_dto.WorkflowsDto.WorkflowView;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<WorkflowView> response = client.workflows().getWorkflow("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Workflows.GetWorkflowAsync("wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.workflows.getWorkflow(
'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Workflows().GetWorkflow(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"workflow": {
"object": "<string>",
"id": "<string>",
"status": "<string>",
"code": "<unknown>",
"name": "<string>",
"display_name": "<string>",
"description": "<unknown>",
"entity": "<string>",
"entity_id": 123,
"event": "<string>",
"is_pre_built": true,
"enable_stage": true,
"current_version": {
"id": "<string>",
"name": "<string>",
"object": "<string>"
},
"custom_form": "<unknown>",
"created_on": "<string>",
"last_updated_on": "<string>",
"created_by": {
"name": "<string>",
"object": "<string>"
},
"last_updated_by": {
"name": "<string>",
"object": "<string>"
},
"href": "<string>"
}
}{
"object": "<string>",
"request_id": "<string>",
"status": 123,
"code": "<string>",
"message": "<string>",
"doc_url": "<string>",
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>",
"doc_url": "<string>"
}
]
}Returns the workflow under
workflow. A deleted workflow returns 404.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token.