Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Model Sync

List Syncs

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}.

get/api/syncs

Query parameters

activeboolean nullable

Filter to only active or only paused syncs.

Example:true

Filter to only active or only paused syncs.

mode'create' | 'update' | 'updateOrCreate' | 'replace' | 'append' | 'remove' | 'snapshot'

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

target_connection_idstring uuid

Filter to syncs that write to the specified target connection.

Example:0b155265-c537-44c9-9359-a3ceb468a4da

Filter to syncs that write to the specified target connection.

page_tokenstring

Pagination cursor returned in the previous response. Omit on the first request.

Example:AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K==

Pagination cursor returned in the previous response. Omit on the first request.

limitinteger

Maximum number of syncs to return. Default and maximum is 50.

Example:50

Maximum number of syncs to return. Default and maximum is 50.

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "active": true,
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "mode": "create",
      "model_ids": [
        "12345678-1234-1234-1234-123456789012",
        "98765432-1234-1234-1234-123456789012"
      ],
      "name": "Users Sync",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "schedule": {
        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "day_of_month": "1",
        "day_of_week": "monday",
        "hour": "12",
        "minute": "30",
        "month": "1",
        "run_after": {
          "bulk_sync_ids": [
            "248df4b7-aa70-47b8-a036-33ac447e668d"
          ],
          "sync_ids": [
            "248df4b7-aa70-47b8-a036-33ac447e668d"
          ]
        }
      },
      "target_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "target_object": "Users",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      }
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}