Skip to navigation

Model Sync Field Query

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.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the connection.

Headers

X-Polytomic-VersionstringOptional

Query parameters

paramsmap from strings to stringsOptional

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

Response

OK
datalist of objects or nullOptional

Errors

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