v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB

Schemas

Get Schema

Returns a single schema on a connection.

The schema is returned from the connection's cached schema set. If the upstream source has changed since the last inspection, the result may be stale.

📘 Trigger POST /api/connections/{id}/schemas/refresh and wait for it to complete before fetching this endpoint if you need up-to-date field definitions.

get/api/connections/{id}/schemas/{schema_id}

Path parameters

idstring uuid required

Unique identifier of the connection.

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

Unique identifier of the connection.

schema_idstring required

Identifier of the schema within the connection. Format depends on the connection type (e.g. schema.table for databases, object name for SaaS backends).

Example:public.users

Identifier of the schema within the connection. Format depends on the connection type (e.g. schema.table for databases, object name for SaaS backends).

Headers

X-Polytomic-Versionstring

Response

Example response

{
  "data": {
    "fields": [
      {
        "id": "email",
        "is_primary_key": true,
        "name": "Email",
        "remote_type": "varchar(255)"
      }
    ],
    "id": "contact",
    "name": "Contact"
  }
}