List Syncs | Polytomic Docs

from polytomic import Polytomic
client = Polytomic(
    version="YOUR_VERSION",
    token="YOUR_TOKEN",
)
client.model_sync.list(
    active=True,
    target_connection_id="0b155265-c537-44c9-9359-a3ceb468a4da",
)

{
  "data": [
    {
      "active": true,
      "created_at": "2024-01-15T09:30:00Z",
      "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",
      "only_enrich_updates": false,
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "schedule": {
        "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
      },
      "skip_initial_backfill": false,
      "sync_all_records": false,
      "target_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "target_object": "Users",
      "updated_at": "2024-01-15T09:30:00Z",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      }
    }
  ],
  "pagination": {
    "next_page_token": "AmkYh8v0jR5B3kls2Qcc9y8MjrPmvR4CvaK7H0F4rEwqvg76K=="
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

activebooleanOptional

modeenumOptional

target_connection_idstringOptional

page_tokenstringOptional

limitintegerOptional

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

Response

datalist of objects

paginationobject

Errors

400

Model Sync List Request Bad Request Error

401

Model Sync List Request Unauthorized Error

404

Model Sync List Request Not Found Error

500

Model Sync List Request Internal Server Error

Authentication

Headers

Query parameters

Response

Errors