> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://apidocs.polytomic.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server. # Get Connection Type GET https://app.polytomic.com/api/connection_types/{id} 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. Reference: https://apidocs.polytomic.com/api-reference/connections/get-connection-type-schema ## Authentication - `Authorization` header (basic auth, required) — This is the Polytomic deployment key (on-premises only) - `Authorization` header (bearer token, required) — This is the Polytomic API key ## Request ### Path parameters - `id` (string, required) — Connection type identifier (e.g. postgresql, salesforce, hubspot). ## Response ### 200 OK - `$anchor` (string, optional) - `$comment` (string, optional) - `$defs` (map from string to JsonschemaSchema, optional) - `$dynamicRef` (string, optional) - `$id` (string, optional) - `$ref` (string, optional) - `$schema` (string, optional) - `additionalProperties` (JsonschemaSchema, optional) - `allOf` (list of JsonschemaSchema, optional) - `anyOf` (list of JsonschemaSchema, optional) - `const` (any, optional) - `contains` (JsonschemaSchema, optional) - `contentEncoding` (string, optional) - `contentMediaType` (string, optional) - `contentSchema` (JsonschemaSchema, optional) - `default` (any, optional) - `dependentRequired` (map from string to list of string, optional) - `dependentSchemas` (map from string to JsonschemaSchema, optional) - `deprecated` (boolean, optional) - `description` (string, optional) - `else` (JsonschemaSchema, optional) - `enum` (list of any, optional) - `examples` (list of any, optional) - `exclusiveMaximum` (string, optional) - `exclusiveMinimum` (string, optional) - `format` (string, optional) - `if` (JsonschemaSchema, optional) - `items` (JsonschemaSchema, optional) - `maxContains` (integer, optional, nullable) - `maxItems` (integer, optional, nullable) - `maxLength` (integer, optional, nullable) - `maxProperties` (integer, optional, nullable) - `maximum` (string, optional) - `minContains` (integer, optional, nullable) - `minItems` (integer, optional, nullable) - `minLength` (integer, optional, nullable) - `minProperties` (integer, optional, nullable) - `minimum` (string, optional) - `multipleOf` (string, optional) - `not` (JsonschemaSchema, optional) - `oneOf` (list of JsonschemaSchema, optional) - `pattern` (string, optional) - `patternProperties` (map from string to JsonschemaSchema, optional) - `prefixItems` (list of JsonschemaSchema, optional) - `properties` (V2OrderedMapStringGithubComInvopopJsonschemaSchema, optional) - `propertyNames` (JsonschemaSchema, optional) - `readOnly` (boolean, optional) - `required` (list of string, optional) - `then` (JsonschemaSchema, optional) - `title` (string, optional) - `type` (string, optional) - `uniqueItems` (boolean, optional) - `writeOnly` (boolean, optional) ## Errors ### 401 Unauthorized Error Unauthorized - `code` (integer, optional) — Application-specific error code. - `context` (map from string to any, optional) — Application context. - `error` (string, optional) — Error message. - `status` (string, optional) — Status text. ### 404 Not Found Error Not Found - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ### 500 Internal Server Error Internal Server Error - `key` (string, optional) - `message` (string, optional) - `metadata` (map from string to any, optional) - `status` (integer, optional) ## Types ### JsonschemaSchema - `$anchor` (string, optional) - `$comment` (string, optional) - `$defs` (map from string to JsonschemaSchema, optional) - `$dynamicRef` (string, optional) - `$id` (string, optional) - `$ref` (string, optional) - `$schema` (string, optional) - `additionalProperties` (JsonschemaSchema, optional) - `allOf` (list of JsonschemaSchema, optional) - `anyOf` (list of JsonschemaSchema, optional) - `const` (any, optional) - `contains` (JsonschemaSchema, optional) - `contentEncoding` (string, optional) - `contentMediaType` (string, optional) - `contentSchema` (JsonschemaSchema, optional) - `default` (any, optional) - `dependentRequired` (map from string to list of string, optional) - `dependentSchemas` (map from string to JsonschemaSchema, optional) - `deprecated` (boolean, optional) - `description` (string, optional) - `else` (JsonschemaSchema, optional) - `enum` (list of any, optional) - `examples` (list of any, optional) - `exclusiveMaximum` (string, optional) - `exclusiveMinimum` (string, optional) - `format` (string, optional) - `if` (JsonschemaSchema, optional) - `items` (JsonschemaSchema, optional) - `maxContains` (integer, optional, nullable) - `maxItems` (integer, optional, nullable) - `maxLength` (integer, optional, nullable) - `maxProperties` (integer, optional, nullable) - `maximum` (string, optional) - `minContains` (integer, optional, nullable) - `minItems` (integer, optional, nullable) - `minLength` (integer, optional, nullable) - `minProperties` (integer, optional, nullable) - `minimum` (string, optional) - `multipleOf` (string, optional) - `not` (JsonschemaSchema, optional) - `oneOf` (list of JsonschemaSchema, optional) - `pattern` (string, optional) - `patternProperties` (map from string to JsonschemaSchema, optional) - `prefixItems` (list of JsonschemaSchema, optional) - `properties` (V2OrderedMapStringGithubComInvopopJsonschemaSchema, optional) - `propertyNames` (JsonschemaSchema, optional) - `readOnly` (boolean, optional) - `required` (list of string, optional) - `then` (JsonschemaSchema, optional) - `title` (string, optional) - `type` (string, optional) - `uniqueItems` (boolean, optional) - `writeOnly` (boolean, optional) ### V2OrderedMapStringGithubComInvopopJsonschemaSchema ## Examples **Response** ```json { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "additionalProperties": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "allOf": [ { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true } ], "anyOf": [ { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true } ], "contains": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "contentEncoding": "string", "contentMediaType": "string", "contentSchema": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "else": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "if": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "items": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "not": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "oneOf": [ { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true } ], "pattern": "string", "patternProperties": {}, "prefixItems": [ { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true } ], "properties": {}, "propertyNames": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "readOnly": true, "required": [ "string" ], "then": { "$anchor": "string", "$comment": "string", "$defs": {}, "$dynamicRef": "string", "$id": "string", "$ref": "string", "$schema": "string", "allOf": [ null ], "anyOf": [ null ], "contentEncoding": "string", "contentMediaType": "string", "dependentRequired": {}, "dependentSchemas": {}, "deprecated": true, "description": "string", "enum": [ null ], "examples": [ null ], "exclusiveMaximum": "string", "exclusiveMinimum": "string", "format": "string", "maxContains": 1, "maxItems": 1, "maxLength": 1, "maxProperties": 1, "maximum": "string", "minContains": 1, "minItems": 1, "minLength": 1, "minProperties": 1, "minimum": "string", "multipleOf": "string", "oneOf": [ null ], "pattern": "string", "patternProperties": {}, "prefixItems": [ null ], "properties": {}, "readOnly": true, "required": [ "string" ], "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true }, "title": "string", "type": "string", "uniqueItems": true, "writeOnly": true } ``` **SDK Code** ```typescript import { PolytomicClient } from "polytomic"; async function main() { const client = new PolytomicClient({ token: "YOUR_TOKEN_HERE", version: "X-Polytomic-Version", }); await client.connections.getConnectionTypeSchema("postgresql"); } main(); ``` ```python from polytomic import Polytomic client = Polytomic( token="YOUR_TOKEN_HERE", version="X-Polytomic-Version", ) client.connections.get_connection_type_schema( id="postgresql", ) ``` ```go package example import ( context "context" client "github.com/polytomic/polytomic-go/v24/client" option "github.com/polytomic/polytomic-go/v24/option" ) func do() { client := client.NewClient( option.WithToken( "YOUR_TOKEN_HERE", ), option.WithVersion( "X-Polytomic-Version", ), ) client.Connections.GetConnectionTypeSchema( context.TODO(), "postgresql", ) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.polytomic.com/api/connection_types/postgresql") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Polytomic-Version"] = 'X-Polytomic-Version' request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.polytomic.com/api/connection_types/postgresql") .header("X-Polytomic-Version", "X-Polytomic-Version") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://app.polytomic.com/api/connection_types/postgresql', [ 'headers' => [ 'X-Polytomic-Version' => 'X-Polytomic-Version', ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://app.polytomic.com/api/connection_types/postgresql"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); request.AddHeader("X-Polytomic-Version", "X-Polytomic-Version"); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = [ "X-Polytomic-Version": "X-Polytomic-Version", "Authorization": "Basic \(credentials)" ] let request = NSMutableURLRequest(url: NSURL(string: "https://app.polytomic.com/api/connection_types/postgresql")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```