Schema

List a side's tables

The tables of the base one side is connected to, from the cache the app also uses; the first call fetches them from the connected app. 202 means another request is already loading them — retry the same GET.

get/v1/sync/syncs/{sync_id}/tables

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/sync/syncs/{sync_id}/tables
  • Auth: HTTP bearer

Path parameters

sync_idstring required
Example:sync_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41

Query parameters

side'left' | 'right' required
refreshstring

Refetch from the connected app instead of serving the cache. Needs the sync to be off.

Response

The tables on that side.

fetched_atstring date-time nullable required

When this listing was last fetched from the connected app. Pass ?refresh=true to refetch.

Example response

{
  "data": [
    {
      "id": "table_7d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "remote_id": "tblContacts",
      "name": "Contacts",
      "views": {
        "required": true,
        "options": [
          {
            "value": "viwActive",
            "name": "Active"
          }
        ]
      }
    }
  ]
}

Changes

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