Clay: Query

Run a structured query across one or more tables.

Tool ID: clay_query

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'clay_query',
  {
    "query": {
      "tables": [
        {
          "id": "id_123"
        }
      ]
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute clay_query --input '{
  "query": {
    "tables": [
      {
        "id": "id_123"
      }
    ]
  }
}' --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get clay_query --json for the complete live contract.

Input reference

Runs a structured query against Clay table data and returns records with field metadata. Results are paginated: pass the returned cursor back to fetch the next page. Scans return rows in least-recently-updated-first order and reflect writes that land while you paginate — a scan returns every record visible when it started and picks up records written while it runs, and a record updated mid-scan can be returned again with fresher data, so deduplicate by id if you need each record once.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	Opaque cursor from the previous response. Scans page in least-recently-updated-first order and reflect concurrent writes: a record updated mid-scan can be returned again, so deduplicate by id.
`payload.limit`	`integer`	No	`50`	Minimum: 1. Maximum: 100.
`payload.query`	`object`	Yes	—	—

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.cursor`	`string`	No	—	—
`result.data.data`	`array`	Yes	—	—
`result.data.fields`	`record`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation