CLclay
tables

Run a structured query across one or more tables

Changed on

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.

post/tables/query

Request

  • Base URL
    https://api.clay.com/public/v0
  • Auth
    API key in header clay-api-key

Request body

cursorstring

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.

limitinteger

Response

200

cursorstring
dataobject[] required
fieldsobject
truncatedboolean

True when more results matched than the limit but no cursor can be issued (grouped, aggregated, or custom-ordered queries do not support cursor pagination). Narrow the query or raise the limit to see the rest.

Changes

  • 04621d9c0274Revision changes
    • info

      added the optional property to the response with the status

  • 3b86731e7a59Revision changes
    • breaking

      added to the // response property oneOf list for the response status

    • info

      request property //////// list-of-types was widened by adding types number to media type application/json

    • info

      removed from the // response property anyOf list for the response status