Skip to navigation
ServicesTemporal ServiceTemporal APIworkflow

Get Workflow Form

View as MarkdownOpen in Claude
Return the v1 input form of an API workflow, looked up by its stable form ID.

Authentication

AuthorizationBearer

Bearer JWT used by CLI and machine clients on svc-* endpoints. Authentication is required by default, but deployments may disable it with [auth] required = false. Browser OIDC sessions, mTLS, SPIFFE identities, and trusted gateway identity headers may also satisfy authentication outside this generated client flow.

Path parameters

form_idstringRequiredformat: "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"

Stable lowercase kebab-case workflow form identifier.

Response

Successful Response
requireslist of strings
schemamap from strings to any
ui_schemaobject

The supported subset of an RJSF uiSchema: root options plus one entry per top-level schema property.

ui_schema_versioninteger

Errors

404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error