Polytomic

opencollection: 1.0.0
info:
  name: API Reference
  version: 1.0.0
items:
- info:
    name: subpackage_connections
    type: folder
  items:
  - info:
      name: Get Connection Types
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connection_types
      headers:
      - name: X-Polytomic-Version
        value: ''
    docs: 'Lists all connection types supported by this deployment.


      Each entry includes per-type metadata:


      - The available operations the connection type supports.

      - Its category.

      - Whether the connection type is enabled for the caller''s organization.

      - Which modes (source, destination, enrichment) it can act as.'
  - info:
      name: Get Connection Type
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connection_types/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Connection type identifier (e.g. postgresql, salesforce, hubspot).
    docs: 'Returns the JSON schema for a connection type.


      This schema is intended for building forms or validating configuration payloads

      client-side. It describes the structure Polytomic expects when you create or

      update a connection of the given type.


      The response is metadata about the shape of the configuration, not a live

      connection instance and not a set of current credential values.'
  - info:
      name: Connection Type Parameter Values
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/connection_types/:type/parameter_values
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: type
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Returns completion values for parameter fields on a connection type.


      This endpoint is useful during connection setup, before a connection exists or

      before you want to persist it. The supplied `parameters` are applied to a

      temporary in-memory connection shape and used to resolve dependent options.


      When an endpoint requires upstream authorization before it can return values,

      Polytomic returns an error instead of guessing. In that case, complete the

      authorization flow first and call the endpoint '
  - info:
      name: List Connections
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
    docs: 'Lists every connection in the caller''s organization, with sensitive fields redacted.


      Sensitive configuration values — passwords, API tokens, private keys — are

      redacted from all responses. To understand which fields a connection type

      exposes, consult the parameter schema returned by

      [`GET /api/connection_types`](../../api-reference/connections/get-types).


      To inspect the data objects available on a specific connection, use

      [`POST /api/connections/{id}/schemas/refresh`](../../api-reference/schem'
  - info:
      name: Create Connection
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/connections
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Creates a new connection of the specified type.


      Use [`GET /api/connection_types`](../../api-reference/connections/get-types) to retrieve the

      list of available types and their parameter schemas. The `configuration`

      object is type-specific; consult the [integration

      guides](../../guides/configuring-your-connections/overview)

      for the required and optional fields for each type.


      > 📘 Polytomic validates the connection against the upstream service

      > immediately on creation. The request will fail if t'
  - info:
      name: Connect
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/connections/connect/
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Creates a Polytomic Connect session and returns a redirect URL that embeds the Connect modal.


      See also:


      - [Embedding authentication](../../../guides/embedding-authentication), a guide to using Polytomic Connect.'
  - info:
      name: Test Connection
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/connections/test
      headers:
      - name: X-Polytomic-Version
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Tests a connection configuration.


      This endpoint is useful for setup flows that want to verify credentials before

      persisting them.


      If you provide `connection_id`, Polytomic starts from the saved configuration

      for that connection and then applies the request''s `configuration` values on

      top. This lets callers test a partial change without resending every existing

      field.


      The request does not persist any configuration changes even when validation

      succeeds.'
  - info:
      name: Get Connection
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: 'Returns a single connection by ID, with sensitive fields redacted.


      To inspect the schemas available on this connection, trigger a refresh with

      [`POST /api/connections/{id}/schemas/refresh`](../../../api-reference/schemas/refresh) and

      track progress via

      [`GET /api/connections/{id}/schemas/status`](../../../api-reference/schemas/get-status).'
  - info:
      name: Update Connection
      type: http
    http:
      method: PUT
      url: https://app.polytomic.com/api/connections/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Updates a connection''s configuration.


      Updating a connection is a **full replacement** of its configuration. Any

      `configuration` field you omit is cleared. To make a partial change, fetch

      the current connection with

      [`GET /api/connections/{id}`](../../../api-reference/connections/get), apply your edits, and send the

      complete object back.


      > 📘 The connection is re-validated against the upstream service after every

      > update. The request will fail if the new credentials or endpoint cannot be

      > rea'
  - info:
      name: Delete Connection
      type: http
    http:
      method: DELETE
      url: https://app.polytomic.com/api/connections/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: force
        value: ''
        type: query
    docs: 'Deletes a connection.


      > 🚧 Deleting a connection that is referenced by fieldsets, syncs, bulk

      > syncs, or schedules returns `422 connection in use` unless you pass

      > `force=true`. With `force=true`, the API deletes those dependent

      > resources before removing the connection.'
  - info:
      name: Connection Parameter Values
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/parameter_values
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: 'Returns completion values for parameter fields on a persisted connection.


      Use this endpoint when the available options for one parameter depend on the

      connection''s saved credentials or previously selected settings. For example,

      after a connection is authorized, the upstream service may be able to return

      lists of databases, schemas, or similar selectable values.


      For new setup flows, prefer

      [`POST /api/connection_types/{type}/parameter_values`](../../../../api-reference/connections/get-type-para'
  - info:
      name: Execute Connection Proxy
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/connections/:id/proxy
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection to proxy the request through.
      body:
        type: json
        data: '{}'
    docs: 'Proxies an HTTP request to a connection''s underlying API using the connection''s stored credentials, subject to
      per-connection rate limits and size caps.


      This endpoint is intended for controlled passthrough use, not as a general

      replacement for Polytomic''s modeled endpoints. The request is executed with the

      connection''s stored credentials and inherited base URL, headers, and query

      parameters.


      Before building requests dynamically, call

      [`GET /api/connections/{id}/proxy/info`](../../../../api-ref'
  - info:
      name: Get Connection Proxy Info
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/proxy/info
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection whose proxy contract should be returned.
    docs: 'Returns the proxy contract for a connection.


      Use this endpoint before calling

      [`POST /api/connections/{id}/proxy`](../../../../../api-reference/connections/execute-proxy)

      when you need to build requests programmatically. The response shows:


      - the inherited base URL that all proxied requests are sent to

      - locked headers and query parameters that are attached automatically

      - blocked request and response headers

      - allowed HTTP methods and body shapes

      - timeout, rate-limit, and payload-size limits'
  - info:
      name: List Current Org Shared Connections
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/shared
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the parent connection whose shared copies should be listed.
    docs: 'Lists shared copies of a connection that the caller''s organization owns.


      The returned connections are the child copies, not the parent connection

      itself. This is useful when a partner workflow needs to confirm which

      downstream organizations have already received a shared copy.


      Creating a new shared copy is a separate operation. Use

      [`POST /api/organizations/{org_id}/connections/{connection_id}/share`](../../../../api-reference/connections/create-shared-connection)

      for the v5 partner-scoped flo'
  - info:
      name: List Partner Shared Connections
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/organizations/:org_id/connections/:connection_id/shared
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: org_id
        value: ''
        type: path
        description: Unique identifier of the organization that owns the parent connection.
      - name: connection_id
        value: ''
        type: path
        description: Unique identifier of the parent connection whose shared copies should be listed.
    docs: 'Lists shared copies of a connection owned by a specific organization in the partner account.


      The `org_id` must match the organization that owns the parent connection. If it

      does not, the endpoint returns `404` rather than exposing information about the

      parent connection.


      This endpoint is useful in partner workflows where the parent connection is in

      the partner owner organization and the caller needs to audit which child

      organizations already have a shared copy.'
  - info:
      name: Create Partner Shared Connection
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/organizations/:org_id/connections/:connection_id/shared
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: org_id
        value: ''
        type: path
        description: Unique identifier of the organization that owns the parent connection.
      - name: connection_id
        value: ''
        type: path
        description: Unique identifier of the parent connection to share.
      body:
        type: json
        data: '{}'
    docs: Shares a connection with another organization in the caller's partner account.
- info:
    name: subpackage_models
    type: folder
  items:
  - info:
      name: Get Enrichment Source
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/modelsync/enrichment-source
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection.
      - name: params
        value: ''
        type: query
        description: Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration
          fields returned by previous calls to this endpoint.
    docs: '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 th'
  - info:
      name: Enrichment Fields
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/enrichment/:connection_id/inputfields
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: connection_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Returns the valid input field sets for an enrichment configuration on a connection.


      When configuring an enrichment source in a model sync, use this endpoint to

      discover which input fields the enrichment connection requires. Pass the

      proposed enrichment configuration in the request body; the response lists the

      valid input field sets that map your model''s fields to the enrichment service''s

      expected inputs.'
  - info:
      name: Preview Model
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/model-preview
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: async
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: 'Submits a job that previews the fields a model would expose without persisting it.


      The response contains a job ID that resolves to the list of fields the model

      would expose. Poll the job until it completes to retrieve the field list. The

      model is not persisted — this endpoint is useful for validating a query or

      configuration before calling [`POST /api/models`](../../api-reference/models/create) to save it.'
  - info:
      name: List Models
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/models
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
    docs: 'Lists all models in the caller''s organization.


      Results are ordered by `updated_at` descending, with `id` used as a tiebreaker.

      If more results are available, the response includes `pagination.next_page_token`.

      Pass that token back unchanged to continue from the last item you received.


      The token is opaque. Do not construct or edit it yourself.


      The `limit` is capped at 50. Values above that cap are reduced to 50, and

      non-positive values fall back to the same default.'
  - info:
      name: Create Model
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/models
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: async
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: 'Creates a new model.


      A model defines a query or view over a connection''s data — for example, a SQL

      query, a filtered object, or a joined dataset. Models are used as sources when

      creating model syncs.


      The connection referenced by `connection_id` must have source capabilities. Use

      [`GET /api/connection_types/{id}`](../../api-reference/connections/get-connection-type-schema) to check

      whether a connection type supports use as a source.'
  - info:
      name: Get Model
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/models/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: async
        value: ''
        type: query
    docs: 'Returns a single model by ID, including its source fields, identity, and filters.


      The response includes the model''s source fields, identity column, and any

      configured filters. To preview the data a model would return without saving

      changes, use [`GET /api/models/{id}/sample`](../../../api-reference/models/sample).'
  - info:
      name: Update Model
      type: http
    http:
      method: PUT
      url: https://app.polytomic.com/api/models/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: async
        value: ''
        type: query
      body:
        type: json
        data: '{}'
    docs: 'Updates a model''s configuration.


      Updating a model is a **full replacement** of its configuration. Every field in

      the request body is written to the model; any field you omit is cleared or reset

      to its default value.


      To make a partial change, fetch the current model with

      [`GET /api/models/{id}`](../../../api-reference/models/get), modify the fields you want to change, and send

      the complete object back in the update request.


      Changes to source fields, filters, or the identity column take effect '
  - info:
      name: Delete Model
      type: http
    http:
      method: DELETE
      url: https://app.polytomic.com/api/models/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: async
        value: ''
        type: query
    docs: 'Deletes a model.


      > 🚧 Deleting a model used by one or more syncs will break those syncs. Remove

      > or reconfigure any syncs that reference this model before deleting it.'
  - info:
      name: Sample Records
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/models/:id/sample
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      - name: async
        value: ''
        type: query
    docs: 'Returns a sample of records from a model.


      Synchronous requests must complete within 10 seconds. If the source query or

      enrichment step can exceed that budget, use the asynchronous option so the

      work runs as a background job.'
- info:
    name: subpackage_modelSync
    type: folder
  items:
  - info:
      name: Get Sync Source
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/modelsync/source
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection.
      - name: params
        value: ''
        type: query
        description: Query parameters used to incrementally refine a dependent source configuration. Keys correspond to configuration
          fields returned by previous calls to this endpoint.
    docs: 'Describes the source configuration available on a connection for use as a model sync source.


      Use this endpoint before creating a model to understand what configuration is

      available. Once you have a configuration, resolve the fields available for

      sync mapping with

      [`GET /api/connections/{id}/modelsync/source/fields`](../../../../../api-reference/model-sync/get-source-fields).'
  - info:
      name: Model Sync Field Query
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/modelsync/source/fields
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection.
      - name: params
        value: ''
        type: query
        description: Source configuration, matching the params used with GET /api/connections/{id}/modelsync/source, that
          selects the specific source to return fields for.
    docs: '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 pa'
  - info:
      name: List Syncs
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/syncs
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: active
        value: ''
        type: query
        description: Filter to only active or only paused syncs.
      - name: mode
        value: ''
        type: query
        description: Filter by sync target mode (e.g. create, updateOrCreate, enrich).
      - name: target_connection_id
        value: ''
        type: query
        description: Filter to syncs that write to the specified target connection.
      - name: page_token
        value: ''
        type: query
        description: Pagination cursor returned in the previous response. Omit on the first request.
      - name: limit
        value: ''
        type: query
        description: Maximum number of syncs to return. Default and maximum is 50.
    docs: 'Lists model syncs in the caller''s organization.


      Results are ordered by `updated_at` descending, with `id` used as a tiebreaker.

      If more results are available, the response includes `pagination.next_page_token`.

      Pass that token back unchanged to continue from the last item you received.


      The token is opaque. Do not construct or edit it yourself.


      The `limit` is capped at 50. Values above that cap are reduced to 50, and

      non-positive values fall back to the same default.


      This endpoint returns syn'
  - info:
      name: Create Sync
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/syncs
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      body:
        type: json
        data: '{}'
    docs: 'Creates a new model sync.


      Create a new sync from one or more models to a destination.


      All of the functionality described in [the product

      documentation](https://docs.polytomic.com/docs/sync-destinations) is

      configurable via the API.


      Guides:


      - [Model sync (Reverse ETL) from Snowflake query to Salesforce](../../guides/code-examples/model-sync-reverse-etl-from-snowflake-query-to-salesforce)

      - [Joined model sync from Postgres, Airtable, and Stripe to Hubspot](../../guides/code-examples/joined-mod'
  - info:
      name: Get Sync Schedule Options
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/syncs/schedules
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
    docs: 'Returns the schedule types available when creating or updating a model sync.


      Use the `type` identifiers returned by this endpoint in the `schedule` field

      when creating or updating a sync via

      [`POST /api/syncs`](../../../api-reference/model-sync/create) or [`PUT /api/syncs/{id}`](../../../api-reference/model-sync/update).'
  - info:
      name: Get Sync
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/syncs/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: 'Returns a single model sync by ID.


      To check whether a sync is currently running or has recently completed, use

      [`GET /api/syncs/{id}/status`](../../../api-reference/model-sync/get-status). For the full history of

      executions, use [`GET /api/syncs/{id}/executions`](../../../api-reference/model-sync/executions/list).'
  - info:
      name: Update Sync
      type: http
    http:
      method: PUT
      url: https://app.polytomic.com/api/syncs/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Updates a model sync''s configuration.


      Updating a model sync is a **full replacement** of the sync''s configuration.

      Every field in the request body is written to the sync; any field you omit is

      cleared or reset to its default value.


      To make a partial change — for example, toggling `active` or adjusting a

      single field mapping — fetch the current sync with

      [`GET /api/syncs/{id}`](../../../api-reference/model-sync/get),

      modify the fields you want to change, and send the complete object back in

      the'
  - info:
      name: Delete Model Sync
      type: http
    http:
      method: DELETE
      url: https://app.polytomic.com/api/syncs/:id
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: 'Deletes a model sync, cancelling any running executions.


      Deletion is permanent. Any running execution is cancelled before the sync

      record is removed. Deleted syncs cannot be recovered; recreate them using

      [`POST /api/syncs`](../../../api-reference/model-sync/create) if needed.'
  - info:
      name: Activate Sync
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/syncs/:id/activate
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Sets whether a model sync is active.


      Only active syncs execute on schedule or in response to a manual trigger. Set

      `active` to `false` to pause a sync without deleting it.


      > 📘 Deactivating a sync does not cancel an execution that is already in

      > progress. Use [`POST /api/syncs/{id}/cancel`](../../../../api-reference/model-sync/cancel) to stop a

      > running execution.'
  - info:
      name: Cancel Sync
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/syncs/:id/cancel
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: The active execution of this sync ID will be cancelled.
    docs: 'Requests cancellation of any running executions on a model sync.


      Cancellation is asynchronous. A successful response means the cancellation

      signal has been queued; the running execution continues until the signal is

      processed. Poll `GET /api/syncs/{id}/status` until the current execution

      reaches a terminal state (`completed`, `canceled`, or `failed`) to confirm

      cancellation has taken effect.'
  - info:
      name: Start Sync
      type: http
    http:
      method: POST
      url: https://app.polytomic.com/api/syncs/:id/executions
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
    docs: 'Starts a new execution of a model sync.


      > 🚧 Force full resync

      >

      > Use caution when setting the `resync` parameter to `true`. This will force a full resync of the data from the source
      system. This can be a time-consuming operation and may impact the performance of the source system. It is recommended
      to only use this option when necessary.'
  - info:
      name: Get Sync Status
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/syncs/:id/status
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
    docs: 'Returns the current status of a model sync.


      The response includes a summary of the most recent execution, including its

      start time, completion time, and record counts. For the complete execution

      history, use [`GET /api/syncs/{id}/executions`](../../../../api-reference/model-sync/executions/list).'
- info:
    name: subpackage_modelSync.subpackage_modelSync/targets
    type: folder
  items:
  - info:
      name: Get Sync Target Fields
      type: http
    http:
      method: GET
      url: https://app.polytomic.com/api/connections/:id/modelsync/target/fields
      headers:
      - name: Authorization
        value: ''
      - name: X-Polytomic-Version
        value: ''
      params:
      - name: id
        value: ''
        type: path
        description: Unique identifier of the connection.
      - name: target
        value: ''
        type: query
        description: Identifier of the target object (e.g. schema.table for a database destination, object name for a SaaS
          destination).
      - name: refresh
        value: ''
        type: query
        description: When true, force a cache refresh of the target's sche

# --- truncated at 32 KB (111 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/polytomic/refs/heads/main/apis.yml