Skip to main content
Every 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
Input: empty object Output

me

account.me Get the Clay user and workspace for the API key Risk: read
Input: empty object Output

Routines

getResults

routines.getResults Get progress, or the paginated per-item results, of a routine run Risk: read
Input Output: object

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
Input
Output

create

search.create Create a people or company search over Clay’s GTM database from a Clay search query Risk: write
Input Output

reference

search.reference Get the Clay search query language reference used by search.create Risk: read
Input: empty object Output

run

search.run Get the next page of a search’s results; each row draws from the workspace search quota Risk: write
Input Output: object