ReferenceAPI Referenceworkflows

Check Workflow Name Availability

Check whether a workflow name is free within the current workspace. Workflow names are unique per workspace among live (non-deleted) workflows, so this lets a client validate a name before create or rename. The `name` is trimmed and validated with the same policy as create — an invalid name returns 422. The check is case-sensitive and ignores soft-deleted workflows, mirroring the underlying uniqueness constraint. Pass `exclude_id` when renaming so the workflow's current name is not reported as taken by itself.

Authentication

AuthorizationBearer
Clerk JWT token

Headers

X-Workspace-Idstring or nullOptional

Query parameters

namestringRequired1-200 characters

Workflow name to check (trimmed before comparison).

exclude_idstring or nullOptionalformat: "uuid"

Workflow to exclude from the check — its own name then reads as available. Pass the workflow’s id when validating a rename.

Response

Successful Response
dataobject

Result of a workflow-name availability check within a workspace.

metaobject

Errors

422
Unprocessable Entity Error