workflows get - Clay docs

Fetch one workflow by id. The response returns the workflow id, name, and a url that opens it in Clay. To list every workflow in the workspace, use clay workflows list.

clay workflows get <workflowId>

Arguments

Argument	Description
`workflowId`	Workflow id, e.g. `wf_abc123`. Required.

Output

{
  "id": "wf_abc123",
  "name": "Lead enrichment",
  "url": "https://app.clay.com/..."
}

Field	Type	Description
`id`	string	Workflow id.
`name`	string	Display name.
`url`	string	Link that opens the workflow in Clay.

Errors

Code	Exit	Notes
`validation_error`	2	`workflowId` argument is required.
`not_found`	6	No workflow with that id.
`auth_forbidden`	3	The API key lacks the `terracotta:cli` scope.

Examples

clay workflows get wf_abc123
clay workflows get wf_abc123 | jq -r '.url'
clay workflows list | jq -r '.data[0].id' | xargs clay workflows get

​Arguments

​Output

​Errors

​Examples

Arguments

Output

Errors

Examples