POpolytomic
Schemas

Get Schema

Changed on

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}

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

Unique identifier of the connection

Example:248df4b7-aa70-47b8-a036-33ac447e668d
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

Headers

X-Polytomic-Versionstring

Response

OK

Example response

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

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 61c2b96f65baRevision changes
    • breaking

      the /// response's property type changed from object to no type for status

    • breaking

      the /// response's property type changed from string to no type for status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      added to the /// response property allOf list for the response status

    • info

      removed the array enum value from the /// response property for the response status

    • info

      removed the binary enum value from the /// response property for the response status

    • info

      removed the boolean enum value from the /// response property for the response status

    • info

      removed the datetime enum value from the /// response property for the response status

    • info

      removed the number enum value from the /// response property for the response status

    • info

      removed the object enum value from the /// response property for the response status

    • info

      removed the string enum value from the /// response property for the response status

    • info

      removed the unknown enum value from the /// response property for the response status