Model Sync

Model Sync Field Query

Changed on

Returns the source fields available on a connection for a given source configuration.

Pass the model's source configuration as query parameters to resolve the fields that the connection will expose for that specific configuration. The returned fields are what can be referenced in sync field mappings.

📘 Results depend on the source configuration you supply. A different table or query in the configuration may return a completely different field list.

The available source configuration parameters are described by GET /api/connections/{id}/modelsync/source.

Query parameter format

Send each source setting as a bracketed key with a single string value. For example, a source configured with stream_id: "deals" uses params[stream_id]=deals.

With Polytomic MCP, pass the bracketed key directly in query:

async () => {
  return polytomic.request({
    method: "GET",
    path: "/api/connections/<connection_id>/modelsync/source/fields",
    query: {"params[stream_id]": "deals"}
  });
}

⚠️ Send one value per setting

Each setting uses only the first value if you repeat its query key. An empty array suffix, such as params[stream_id][]=deals, is rejected with 400 Bad Request. Use params[stream_id]=deals instead.

get/api/connections/{id}/modelsync/source/fields

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the connection

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Query parameters

paramsobject

Source configuration, matching the params used with GET /api/connections/{id}/modelsync/source, that selects the specific source to return fields for

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": [
    {
      "created_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      },
      "description": "Unique identifier",
      "example": 123,
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "label": "ID",
      "name": "id",
      "remote_type": "string",
      "type": "string",
      "unique": true
    }
  ]
}

Changes

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added to the // response property allOf list for the response status

    • warning

      for the query request parameter params, the type of property additionalProperties/ changed from array to string