List Syncs | Polytomic Docs

curl https://app.polytomic.com/api/syncs \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

{
  "data": [
    {
      "active": true,
      "created_at": "2024-01-15T09:30:00Z",
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "encryption_passphrase": "string",
      "fields": [
        {
          "target": "name",
          "encryption_enabled": true,
          "new": false,
          "override_value": "fixed_value",
          "source": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "sync_mode": "create"
        }
      ],
      "filter_logic": "string",
      "filters": [
        {
          "function": "Equality",
          "field": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "field_id": "field1",
          "field_type": "Model",
          "label": "A"
        }
      ],
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "identity": {
        "function": "Equality",
        "source": {
          "field": "id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        },
        "target": "name",
        "new_field": true,
        "remote_field_type_id": "string"
      },
      "mode": "create",
      "model_ids": [
        "string"
      ],
      "name": "Users Sync",
      "only_enrich_updates": false,
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "override_fields": [
        {
          "target": "name",
          "encryption_enabled": true,
          "new": false,
          "override_value": "fixed_value",
          "source": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "sync_mode": "create"
        }
      ],
      "overrides": [
        {
          "field": {
            "field": "id",
            "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
          },
          "field_id": "field1",
          "function": "Equality"
        }
      ],
      "policies": [
        "248df4b7-aa70-47b8-a036-33ac447e668d"
      ],
      "schedule": {
        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "day_of_month": "1",
        "day_of_week": "monday",
        "frequency": "manual",
        "hour": "12",
        "job_id": 1,
        "minute": "30",
        "month": "1",
        "run_after": {
          "bulk_sync_ids": [
            "248df4b7-aa70-47b8-a036-33ac447e668d"
          ],
          "sync_ids": [
            "248df4b7-aa70-47b8-a036-33ac447e668d"
          ]
        },
        "run_after_success_only": true
      },
      "skip_initial_backfill": false,
      "sync_all_records": false,
      "target": {
        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "configuration": {
          "key": "value"
        },
        "create": {
          "name": "value"
        },
        "filter_logic": "string",
        "object": "Users",
        "new_name": "string",
        "search_values": {
          "name": "value"
        }
      },
      "updated_at": "2024-01-15T09:30:00Z",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      }
    }
  ]
}

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

Lists all 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).

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Query parameters

activebooleanOptional

modeenumOptional

target_connection_idstringOptionalformat: "uuid"

Response

datalist of objects or null

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response

Errors