Get Schema | Polytomic Docs

curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/schemas/public.users \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>"

{
  "data": {
    "fields": [
      {
        "association": {
          "id": "fk_user_profile",
          "name": "UserProfileAssociation",
          "reference_to": [
            "public.profiles"
          ],
          "referenced_field": "user_id"
        },
        "id": "email",
        "is_primary_key": true,
        "name": "Email",
        "remote_type": "varchar(255)",
        "type": "string",
        "values": [
          {
            "label": "Personal Email",
            "value": "personal"
          },
          {
            "label": "Work Email",
            "value": "work"
          }
        ]
      }
    ],
    "id": "public.users",
    "name": "Users"
  }
}

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.

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`](../../../../../api-reference/schemas/refresh) > and wait for it to complete before fetching this endpoint if you need > up-to-date field definitions.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Unique identifier of the connection.

schema_idstringRequired

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

Response

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors