Workflows v2 (Plays) / CLI
Get play
Fetch the full definition of a single system play by id. Returns the complete PlayDefinition including inputs/outputs schema, capability metadata, required credentials, retry policy, idempotency key fields, and timeout. Returns 404 when the playId is unknown. Use after list-plays to inspect a candidate step in detail before referencing it from a workflow.
pipeline get-playDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
playIdRequired · string- The play id, e.g. "find-lookalike-companies".
pipeline get-play \
--play-id "00000000-0000-4000-8000-000000000000"Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"playId": {
"type": "string",
"description": "The play id, e.g. \"find-lookalike-companies\"."
}
},
"required": [
"playId"
]
}