clay.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Account
credits
account.credits
Get the workspace data credit and action balances
Risk: read
me
account.me
Get the Clay user and workspace for the API key
Risk: read
user full type
user full type
workspace full type
workspace full type
Routines
getResults
routines.getResults
Get progress, or the paginated per-item results, of a routine run
Risk: read
Output:
object
Output full type
Output full type
run
routines.run
Run a Clay-managed or custom function routine on 1-100 items; spends credits and returns a routine_run_id
Risk: write
items full type
items full type
Search
create
search.create
Create a people or company search over Clay’s GTM database from a Clay search query
Risk: write
Output
reference
search.reference
Get the Clay search query language reference used by search.create
Risk: read
run
search.run
Get the next page of a search’s results; each row draws from the workspace search quota
Risk: write
Output:
object
Output full type
Output full type