v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Model Sync

List Sync Targets

Lists the target objects available on a connection for use as a model sync destination.

If the connection supports creating new destinations, the target_creation object will contain information on what properties are required to create the target.

Target creation properties are all string values; the enum flag indicates if the property has a fixed set of valid values. When enum is true, the Target Creation Property Values endpoint can be used to retrieve the valid values. Alternatively, pass include_target_creation_values=true to inline the values array for each enum property directly in this response.

Sync modes

The sync mode determines which records are written to the destination for a model sync. The modes array for a target object defines the id along with what operations the mode supports.

get/api/connections/{id}/modelsync/targetobjects

Path parameters

idstring uuid required
Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

include_target_creation_valuesboolean

When true, inline the valid values for each enum target-creation property in the response. Skips the separate call to retrieve property values.

When true, inline the valid values for each enum target-creation property in the response. Skips the separate call to retrieve property values.

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "id": "system_object1",
      "modes": [
        {
          "requires_identity": true,
          "supports_per_field_mode": true,
          "supports_target_filters": true
        }
      ],
      "name": "Contact"
    }
  ],
  "target_creation": {
    "properties": [
      {
        "enum": true,
        "id": "account",
        "title": "Account ID",
        "values": [
          "account1",
          "account2"
        ]
      }
    ],
    "supported": true
  }
}