For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Sync Source
      • GETModel Sync Field Query
      • GETList Syncs
      • POSTCreate Sync
      • GETGet Sync Schedule Options
      • GETGet Sync
      • PUTUpdate Sync
      • DELDelete Model Sync
      • POSTActivate Sync
      • POSTCancel Sync
      • POSTStart Sync
      • GETGet Sync Status
Logo
Log inBook a demo
API ReferenceModel Sync

List Syncs

GET
https://app.polytomic.com/api/syncs
GET
/api/syncs
$curl https://app.polytomic.com/api/syncs \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "active": true,
5      "created_at": "2024-01-15T09:30:00Z",
6      "created_by": {
7        "id": "12345678-1234-1234-1234-123456789012",
8        "name": "John Doe",
9        "type": "user"
10      },
11      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
12      "mode": "create",
13      "model_ids": [
14        "12345678-1234-1234-1234-123456789012",
15        "98765432-1234-1234-1234-123456789012"
16      ],
17      "name": "Users Sync",
18      "only_enrich_updates": false,
19      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
20      "schedule": {
21        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
22        "day_of_month": "1",
23        "day_of_week": "monday",
24        "frequency": "manual",
25        "hour": "12",
26        "job_id": 1,
27        "minute": "30",
28        "month": "1",
29        "run_after": {
30          "bulk_sync_ids": [
31            "248df4b7-aa70-47b8-a036-33ac447e668d"
32          ],
33          "sync_ids": [
34            "248df4b7-aa70-47b8-a036-33ac447e668d"
35          ]
36        },
37        "run_after_success_only": true
38      },
39      "skip_initial_backfill": false,
40      "sync_all_records": false,
41      "target_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
42      "target_object": "Users",
43      "updated_at": "2024-01-15T09:30:00Z",
44      "updated_by": {
45        "id": "12345678-1234-1234-1234-123456789012",
46        "name": "John Doe",
47        "type": "user"
48      }
49    }
50  ],
51  "pagination": {
52    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
53  }
54}
Lists model syncs in the caller's organization. Results are ordered by `updated_at` descending, with `id` used as a tiebreaker. If more results are available, the response includes `pagination.next_page_token`. Pass that token back unchanged to continue from the last item you received. The token is opaque. Do not construct or edit it yourself. The `limit` is capped at 50. Values above that cap are reduced to 50, and non-positive values fall back to the same default. This endpoint returns syncs visible to the current caller's organization scope. To inspect a specific sync in more detail, follow up with [`GET /api/syncs/{id}`](../../api-reference/model-sync/get).
Was this page helpful?
Previous

Create Sync

Next

Lists model syncs in the caller’s organization.

Results are ordered by updated_at descending, with id used as a tiebreaker. If more results are available, the response includes pagination.next_page_token. Pass that token back unchanged to continue from the last item you received.

The token is opaque. Do not construct or edit it yourself.

The limit is capped at 50. Values above that cap are reduced to 50, and non-positive values fall back to the same default.

This endpoint returns syncs visible to the current caller’s organization scope. To inspect a specific sync in more detail, follow up with GET /api/syncs/{id}.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Query parameters

activebooleanOptional
Filter to only active or only paused syncs.
modeenumOptional

Filter by sync target mode (e.g. create, updateOrCreate, enrich).

target_connection_idstringOptionalformat: "uuid"
Filter to syncs that write to the specified target connection.
page_tokenstringOptional
Pagination cursor returned in the previous response. Omit on the first request.
limitintegerOptional
Maximum number of syncs to return. Default and maximum is 50.

Response

OK
datalist of objects or null
paginationobject

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error