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
Logo
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
      • POSTExecute Connection Proxy
      • GETGet Connection Proxy Info
      • GETList Current Org Shared Connections
      • GETList Partner Shared Connections
      • POSTCreate Partner Shared Connection
Log inBook a demo
API ReferenceConnections

List Connections

GET
https://app.polytomic.com/api/connections
GET
/api/connections
$curl https://app.polytomic.com/api/connections \
>     -H "Authorization: Bearer <token>"
1{
2  "data": [
3    {
4      "api_calls_last_24_hours": 2021,
5      "configuration": {
6        "database": "example",
7        "hostname": "postgres.example.com",
8        "password": "********",
9        "port": 5432,
10        "username": "user"
11      },
12      "created_at": "2024-01-15T09:30:00Z",
13      "created_by": {
14        "id": "12345678-1234-1234-1234-123456789012",
15        "name": "John Doe",
16        "type": "user"
17      },
18      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
19      "name": "My Postgres Connection",
20      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
21      "parent_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
22      "policies": [
23        "248df4b7-aa70-47b8-a036-33ac447e668d"
24      ],
25      "saved": true,
26      "status": "healthy",
27      "status_error": "error message",
28      "type": {
29        "id": "postgresql",
30        "logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
31        "name": "PostgreSQL",
32        "operations": [
33          "bulksyncsource"
34        ]
35      },
36      "updated_at": "2024-01-15T09:30:00Z",
37      "updated_by": {
38        "id": "12345678-1234-1234-1234-123456789012",
39        "name": "John Doe",
40        "type": "user"
41      }
42    }
43  ]
44}
Lists every connection in the caller's organization, with sensitive fields redacted. Sensitive configuration values — passwords, API tokens, private keys — are redacted from all responses. To understand which fields a connection type exposes, consult the parameter schema returned by [`GET /api/connection_types`](../../api-reference/connections/get-types). To inspect the data objects available on a specific connection, use [`POST /api/connections/{id}/schemas/refresh`](../../api-reference/schemas/refresh) followed by [`GET /api/connections/{id}/schemas/status`](../../api-reference/schemas/get-status).
Was this page helpful?
Previous

Create Connection

Next

Lists every connection in the caller’s organization, with sensitive fields redacted.

Sensitive configuration values — passwords, API tokens, private keys — are redacted from all responses. To understand which fields a connection type exposes, consult the parameter schema returned by GET /api/connection_types.

To inspect the data objects available on a specific connection, use POST /api/connections/{id}/schemas/refresh followed by GET /api/connections/{id}/schemas/status.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Response

OK
datalist of objects or null

Errors

500
Internal Server Error