For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
GuidesAPI Reference
GuidesAPI Reference
  • API Reference
      • GETGet Connection Types
      • GETGet Connection Type
      • POSTConnection Type Parameter Values
      • GETList Connections
      • POSTCreate Connection
      • POSTConnect
      • POSTTest Connection
      • GETGet Connection
      • PUTUpdate Connection
      • DELDelete Connection
      • GETConnection Parameter Values
      • POSTCreate Shared Connection
      • GETList Shared Connections
Logo
Log inBook a demo
API ReferenceConnections

Connection Parameter Values

GET
https://app.polytomic.com/api/connections/:id/parameter_values
GET
/api/connections/:id/parameter_values
$curl https://app.polytomic.com/api/connections/248df4b7-aa70-47b8-a036-33ac447e668d/parameter_values \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>"
1{
2  "data": {
3    "database": {
4      "allows_creation": false,
5      "values": [
6        {
7          "label": "SalesDB",
8          "value": "sales_db"
9        },
10        {
11          "label": "MarketingDB",
12          "value": "marketing_db"
13        },
14        {
15          "label": "HRDB",
16          "value": "hr_db"
17        }
18      ]
19    },
20    "schema": {
21      "allows_creation": true,
22      "values": [
23        {
24          "label": "public",
25          "value": "public"
26        },
27        {
28          "label": "analytics",
29          "value": "analytics"
30        },
31        {
32          "label": "archive",
33          "value": "archive"
34        }
35      ]
36    },
37    "table": {
38      "allows_creation": false,
39      "values": [
40        {
41          "label": "customers",
42          "value": "customers"
43        },
44        {
45          "label": "orders",
46          "value": "orders"
47        },
48        {
49          "label": "products",
50          "value": "products"
51        }
52      ]
53    }
54  }
55}
Returns completion values for parameter fields on a persisted connection. Use this endpoint when the available options for one parameter depend on the connection's saved credentials or previously selected settings. For example, after a connection is authorized, the upstream service may be able to return lists of databases, schemas, or similar selectable values. For new setup flows, prefer [`POST /api/connection_types/{type}/parameter_values`](../../../../api-reference/connections/get-type-parameter-values), which lets you resolve completions before the connection has been created.
Was this page helpful?
Previous

Create Shared Connection

Next

Returns completion values for parameter fields on a persisted connection.

Use this endpoint when the available options for one parameter depend on the connection’s saved credentials or previously selected settings. For example, after a connection is authorized, the upstream service may be able to return lists of databases, schemas, or similar selectable values.

For new setup flows, prefer POST /api/connection_types/{type}/parameter_values, which lets you resolve completions before the connection has been created.

Authentication

AuthorizationBasic

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

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Polytomic-VersionstringRequired

Response

OK
datamap from strings to objects or null

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error