Skip to main content
Fetch the input schema for one Clay action, so you can wire it into a workflow node’s tools. Get a packageId and actionKey from clay workflows actions list. Always bind inputs using the exact names this command returns — never guess them from the action’s name or outputs. For parameters whose options or fields depend on other inputs, resolve them with clay workflows actions dynamic-fields. 
clay workflows actions schema <packageId> <actionKey>

​
Arguments

ArgumentDescription
packageIdAction package id, from workflows actions list. Required.
actionKeyAction key, from workflows actions list. Required.

​
Output

inputParameters is an array of the action’s input parameters — one entry per field you can pass when adding this action to a node’s tools. Each entry typically has name, displayName, type, required, and description. 
{
  "packageId": "56058efe-4757-4fe7-a44b-39c2d730c47a",
  "actionKey": "find-email-from-name",
  "displayName": "Find email from name",
  "inputParameters": [
    {
      "name": "fullName",
      "displayName": "Full name",
      "type": "string",
      "required": true,
      "description": "The person's full name."
    }
  ]
}
FieldTypeDescription
packageIdstringThe action’s package id.
actionKeystringThe action’s key.
displayNamestringHuman-readable action name.
inputParametersarray of objectThe action’s input parameters. Use each name exactly when binding inputs.

​
Errors

CodeExitNotes
validation_error2packageId and actionKey arguments are required.
not_found6No action with that packageId / actionKey.
auth_forbidden3The API key lacks permission for this command.

​
Examples

clay workflows actions schema 56058efe-4757-4fe7-a44b-39c2d730c47a find-email-from-name
clay workflows actions schema <packageId> <actionKey> | jq '.inputParameters'