Refresh schema
This endpoint requires either Connection Admin or Modeler permissions:
- Modelers can use this endpoint on connections that have exactly one shared model
- Connection Admins can use this endpoint on any connection they are an admin of, whether the connection has one or multiple models
Refresh the schema of the specified model. This will cause the model to reflect the latest changes to schemas, views, and fields from the data source. Schema refreshes will remove structures that are no longer present in the source, but not anything created by users.
Depending on whether the Branch-based schema refresh setting is configured:
- If Branch-based schema refresh is enabled, the
branch_idquery parameter is required. Thebranch_idis validated against the shared model. - If Branch-based schema refresh isn’t enabled, do not provide the
branch_idparameter. The API will return a400error in this case.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Query Parameters
Whether to perform a hard refresh (removes dropped objects) or soft refresh (additive only). Defaults to true (hard refresh).
When combined with schemas or tables, a hard refresh is scoped to the selection: dropped objects are removed only inside the selected schemas or tables, and the rest of the model is left untouched.

