List a workflow's stages

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b/stages?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowStages('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowStages('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b', [
    'limit' => 20,
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowStages(
        "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowStagesAsync(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowStages(
  'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
  queryParams: {'limit': 20},
);
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().GetWorkflowStages(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

GET

workflows

{workflow_id}

stages

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/workflows/wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b/stages?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.workflows.getWorkflowStages('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b', {limit: 20});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->workflows->getWorkflowStages('wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b', [
    'limit' => 20,
]);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.workflows().getWorkflowStages(
        "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Workflows.GetWorkflowStagesAsync(
    "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.workflows.getWorkflowStages(
  'wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b',
  queryParams: {'limit': 20},
);
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().GetWorkflowStages(context.Background(), "wf_6f1c2a9e4b3d4c8e9a7b5d2f0e1c3a4b", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {}
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Returns a page of the workflow’s stages under data, with cursor pagination. Other fields filter as filter_<field> for equality or filter_<field>_<operator>, such as filter_created_on_gte.

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.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

workflow_id

string

required

The workflow's wf_ id.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

cursor

string

The pagination.next_cursor of the previous page, to read the page after it.

sort

string

A field to sort by. Prefix it with - for descending order, such as -created_on.

Example:

"-created_on"

Response

200 - application/json

A page of the workflow's stages.

object

string

Always list.

url

string

The path this page was read from.

data

object[]

The workflow's stages.

pagination

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Query Parameters

Response