> This page is for version 2025-09-18 (default). > For other versions, use one of these documentation indexes: > - 2025-09-18 (default): https://apidocs.polytomic.com/2025-09-18/llms.txt > - 2024-02-08: https://apidocs.polytomic.com/2024-02-08/llms.txt > - 2023-04-25: https://apidocs.polytomic.com/2023-04-25/llms.txt > - 2022-12-12: https://apidocs.polytomic.com/2022-12-12/llms.txt > - 2021-05-23: https://apidocs.polytomic.com/2021-05-23/llms.txt > 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 (bearer token, required) — Bearer user API key - `Authorization` header (basic auth, required) — Basic organization-scoped 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` (OrderedMapStringGithubComInvopopJsonschemaSchema, 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 ### 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` (OrderedMapStringGithubComInvopopJsonschemaSchema, 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) ### OrderedMapStringGithubComInvopopJsonschemaSchema ## 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** ```python import requests url = "https://app.polytomic.com/api/connection_types/postgresql" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.polytomic.com/api/connection_types/postgresql'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.polytomic.com/api/connection_types/postgresql" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```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["Authorization"] = 'Bearer ' 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("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.polytomic.com/api/connection_types/postgresql', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.polytomic.com/api/connection_types/postgresql"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] 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() ```