Records

Retrieve a record's status

Everything known about one record's sync state: open issues, a pending delete awaiting review, operations queued right now, per-side flags and links, and its most recent operations. record_id is a rec_ id, or the record's id in the connected app — then sync is required, and table picks a table when the same id exists in more than one.

get/v1/sync/records/{record_id}

Request

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

Path parameters

record_idstring required
Example:rec_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41

A rec_ id, or the record's id in the connected app.

Query parameters

syncstring

The sync to look in. Required for a connected-app id.

tablestring

The table to look in, when the id alone is ambiguous.

Response

The record's status.

idstring required
sync_idstring required
operations_has_moreboolean required

Whether older operations exist beyond the ones embedded here.

operations_urlstring uri required

The full paginated operation history for this record.

app_urlstring uri nullable required

The record's status page in the Whalesync app, for a person looking closer — nothing here needs their attention.

Example response

{
  "id": "rec_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
  "sync_id": "sync_9f2c…",
  "left": {
    "remote_id": "recXYZ",
    "table": {
      "id": "table_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "remote_id": "tblContacts",
      "name": "Contacts"
    }
  },
  "right": {
    "remote_id": "recXYZ",
    "table": {
      "id": "table_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "remote_id": "tblContacts",
      "name": "Contacts"
    }
  },
  "issues": [
    {
      "id": "iss_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "sync_id": "sync_9f2c…",
      "code": "authentication_error",
      "connector": "airtable",
      "table": {
        "id": "table_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
        "remote_id": "tblContacts"
      },
      "record": {
        "id": "rec_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
        "remote_id": "recXYZ"
      },
      "fields": [
        {
          "id": "field_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
          "remote_id": "fldEmail"
        }
      ]
    }
  ],
  "operations": [
    {
      "id": "op_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
      "sync_id": "sync_9f2c…",
      "table": {
        "id": "table_1d0b06b0-6f5e-4a3e-9d15-3a7b0e2f9a41",
        "name": "Contacts"
      },
      "record": {
        "remote_id": "recXYZ"
      }
    }
  ]
}

Changes

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