Skip to main content
GET
Get Workflows

Authorizations

x-maxim-api-key
string
header
required

API key for authentication

Query Parameters

workspaceId
string
required

Unique identifier for the workspace

id
string

Unique identifier of a specific workflow to fetch

name
string

Name of a specific workflow to fetch

folderId
string

Filter workflows by folder. Omit (with ignoreFolders=false) to list root-level workflows.

type
enum<string>
default:HTTP

Workflow type filter. Defaults to HTTP; pass VOICE to list voice workflows.

Available options:
HTTP,
VOICE
ignoreFolders
boolean | null
default:false

When true, include workflows from all folders instead of only root-level ones.

limit
number | null
default:10

Maximum number of records to return (max: 100)

Required range: x <= 100
cursor
string

Pagination cursor (id of the last item from the previous page)

Response

Workflows retrieved successfully

data
object
required

Single Workflow if fetching by id/name, array otherwise.

pagination
object