---
title: "List Sync Targets"
method: GET
path: "/api/connections/{id}/modelsync/targetobjects"
tags: ["Model Sync"]
---

# List Sync Targets

`GET /api/connections/{id}/modelsync/targetobjects`

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](../../../../../api-reference/model-sync/targets/get-create-property)
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.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include_target_creation_values` boolean — 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-Version` string

## Response `200`

OK

- TargetObjectsResponseEnvelope
  - `data` TargetObject[], nullable
    - `id` string — The identifier of the target object.
    - `modes` SupportedMode[] — The supported sync modes and their properties for the target object.
      - `id` 'create' | 'update' | 'updateOrCreate' | 'replace' | 'append' | 'remove' | 'snapshot'
      - `requires_identity` boolean — True if the sync mode requires an identity field mapping.
      - `supports_per_field_mode` boolean — True if the target supports per-field sync modes.
      - `supports_target_filters` boolean — True if the sync mode supports target filters.
    - `name` string — The name of the target object.
  - `target_creation` TargetCreator
    - `properties` TargetPropertyValues[] — The properties that are required for target creation.
      - `enum` boolean — True if the property is an enum.
      - `id` string — The identifier of the target property.
      - `title` string — A human readable title for the target property.
      - `values` UtilEnumValue[] — Valid values for the target property.
        - `label` string, nullable
        - `value` string
    - `supported` boolean — True if the connection supports target creation.

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/polytomic/apis/polytomic-api.md) · [All operations](https://skmtc.net/polytomic/apis/polytomic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polytomic/polytomic-api/versions/5e9bcd4cfb2d/schema)