Get Enrichment Source

Describes the enrichment source configuration available on a connection. Not all connections support enrichment. Call this endpoint to determine whether a connection can serve as an enrichment source in a model sync and, if so, what configuration it accepts. > ⚠️ If the connection does not support enrichment, this endpoint returns > `404`. Check for that status before attempting to configure an enrichment > source on a sync. When a connection does support enrichment, the response describes the configuration fields required to set it up. Pass those values in the `enrichment` block when creating or updating a model sync.

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-VersionstringRequired

Query parameters

paramsmap from strings to lists of stringsOptional
Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration fields returned by previous calls to this endpoint.

Response

OK
dataobject

Errors

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