Schema

List a table's fields

The fields of one table, with the connector-native type and capability flags. Fetched from the connected app on first use and cached; 202 means another request is already loading them — retry the same GET.

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

Request

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

Path parameters

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

A prefixed table id, or the remote id from the connected app.

Query parameters

side'left' | 'right'

Restrict resolution to one side. Useful when the same string is a remote id on one side and a table name on the other (Postgres remote ids are bare table names); without it, the remote id wins.

refreshstring

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

Response

The table's fields.

fetched_atstring date-time nullable required

When these fields were last fetched from the connected app. Pass ?refresh=true to refetch.

Example response

{
  "data": [
    {
      "id": "field_9c0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "remote_id": "fldXYZ",
      "name": "Amount",
      "type": "currency"
    }
  ]
}

Changes

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