Records

Search records

Finds records in one sync by the record's id in the connected app (e.g. an Airtable "rec…" id), a Whalesync rec_ id, or display text. Exact id matches come first. Results are capped, not paginated — when has_more is true, narrow the query. Each hit links to its status document.

get/v1/sync/records

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/sync/records
  • Auth: HTTP bearer

Query parameters

syncstring required

The sync id to search in.

querystring required

A record id, rec_ id, or display text to match.

tablestring

Only records in this table id.

limitinteger

Response

The matching records, best matches first.

has_moreboolean required

Whether more records matched than were returned. Narrow the query to see them.

next_cursorstring nullable required

Always null — search results are not paginated; refine the query.

Example response

{
  "data": [
    {
      "id": "rec_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "sync_id": "sync_9f2c…",
      "remote_id": "recXYZ",
      "table": {
        "id": "table_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
        "remote_id": "tblContacts",
        "name": "Contacts"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.