Skip to main content
List the workflows available to the authenticated workspace. Each entry returns the workflow id, name, and a url that opens it in Clay. Use clay workflows get to fetch a single workflow.
clay workflows list [--limit <n>] [--cursor <token>]
Results are paginated. --limit sets the page size, and the response includes a top-level cursor when more workflows are available; pass it back with --cursor to fetch the next page.

Flags

FlagDescription
--limit <n>Maximum workflows to return per page. A positive integer, 1–200. Defaults to 50.
--cursor <token>Resume from a previous response’s cursor to fetch the next page.

Output

{
  "data": [
    {
      "id": "wf_abc123",
      "name": "Lead enrichment",
      "url": "https://app.clay.com/..."
    }
  ],
  "cursor": "next_page_token"
}
FieldTypeDescription
data[].idstringWorkflow id, e.g. wf_abc123.
data[].namestringDisplay name.
data[].urlstringLink that opens the workflow in Clay.
cursorstringPresent when more workflows are available. Pass it back via --cursor. Omitted on the last page.

Errors

CodeExitNotes
validation_error2--limit is not a positive integer or exceeds 200.
auth_forbidden3The API key lacks the terracotta:cli scope.

Examples

clay workflows list
clay workflows list --limit 10 | jq -r '.data[].id'
clay workflows list | jq -r '.data[] | "\(.id)\t\(.name)"'
clay workflows list --cursor "$CURSOR"