v1
latestOpenAPI 3.0.32026-08-06138294578.6 KBConnections
List Connections
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.
get/api/connections
Headers
X-Polytomic-Versionstring
Response
OK
Example response
{
"data": [
{
"api_calls_last_24_hours": 2021,
"configuration": {
"database": "example",
"hostname": "postgres.example.com",
"password": "********",
"port": 5432,
"username": "user"
},
"created_by": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "John Doe",
"type": "user"
},
"id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"name": "My Postgres Connection",
"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"parent_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
"policies": [
"248df4b7-aa70-47b8-a036-33ac447e668d"
],
"saved": true,
"status": "healthy",
"status_error": "error message",
"type": {
"id": "postgresql",
"logo_dark_url": "https://connect-assets.polytomic.com/logos/dark/postgresql.svg",
"logo_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
"name": "PostgreSQL"
},
"updated_by": {
"id": "12345678-1234-1234-1234-123456789012",
"name": "John Doe",
"type": "user"
}
}
]
}