Syncs
List syncs
List the syncs of the workspace in every region, newest first, with their apps, tables, columns and settings. Deleted syncs are not listed. No region parameter: both regions are read.
Authorization
AuthorizationstringheaderrequiredBearer <key>, where <key> is a workspace API key or a user API key. See Authentication.
workspace_id*integerThe workspace the resources belong to
name?stringOnly the sync with exactly this name. 3 to 63 characters: unaccented letters (A-Z, a-z), numbers, underscores, dashes and spaces only; unique in the workspace
^[A-Za-z0-9_\- ]+$3 <= length <= 63The syncs of the workspace
application/json- response
The syncs of the workspace, newest first
data*array<>The syncs, across both regions
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/bases'{ "data": [ { "base_id": "3f6c1d2e-8a4b-4c7d-9e21-5b6f7a8c9d01", "base_name": "Salesforce accounts to Postgres", "base_status": "running", "base_region": "usnv", "settings": { "max_records_sync_delay_in_seconds": 0 }, "apps": [ { "app_id": "3f9a1c2e", "app_type": "salesforce", "connection_id": "c7d8e9f0-2a3b-4c5d-9e6f-7a8b9c0d1e2f", "connection_name": "Salesforce production", "rate_limit": { "rate": 50, "frequency": 1 }, "delete_protection": false, "bulk_api_access": false, "cdc_method": null, "tables": [ { "table_name": "Account", "table_mapping_id": "7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b", "sync_direction": "bidirectional", "columns": [ { "column_name": "Name", "column_mapping_id": "1a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d" }, { "column_name": "Website", "column_mapping_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e" } ] } ] }, { "app_id": "b71d04e5", "app_type": "postgres", "connection_id": "9b2e4f60-1c3d-4a5e-8f70-2d4c6e8a0b12", "connection_name": "Production Postgres", "rate_limit": null, "delete_protection": true, "bulk_api_access": false, "cdc_method": "triggers", "tables": [ { "table_name": "accounts", "table_mapping_id": "7e8f9a0b-1c2d-4e3f-8a4b-5c6d7e8f9a0b", "sync_direction": "bidirectional", "columns": [ { "column_name": "name", "column_mapping_id": "1a2b3c4d-5e6f-4a7b-9c8d-0e1f2a3b4c5d" }, { "column_name": "website", "column_mapping_id": "2b3c4d5e-6f7a-4b8c-9d0e-1f2a3b4c5d6e" } ] } ] } ] } ]}POSTRun an action
Run one action of an app on its own, outside any workflow, with a connection and the values of its form: the values are checked against the app's live form, then the app runs them once. A read action (get, list, search...) is open to a viewer; any other can change data in the app and needs an editor. A run the app failed or did not answer is answered with its status. With validate_only, every check runs and the answer tells what would run, nothing runs; with validate_only_for_writes, a read runs and an action that can change data only answers that dry run.
GETGet a sync
Read one sync with its apps, tables, columns and settings. A deleted sync is answered as not existing.