List Connections | Polytomic Docs

curl https://app.polytomic.com/api/connections \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -u "<username>:<password>"

{
  "data": [
    {
      "api_calls_last_24_hours": 2021,
      "configuration": {
        "database": "example",
        "hostname": "postgres.example.com",
        "password": "********",
        "port": 5432,
        "username": "user"
      },
      "created_at": "2024-01-15T09:30:00Z",
      "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_url": "https://connect-assets.polytomic.com/logos/postgresql.svg",
        "name": "PostgreSQL",
        "operations": [
          "bulksyncsource"
        ]
      },
      "updated_at": "2024-01-15T09:30:00Z",
      "updated_by": {
        "id": "12345678-1234-1234-1234-123456789012",
        "name": "John Doe",
        "type": "user"
      }
    }
  ]
}

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.

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).

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Response

datalist of objects or null

Errors

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Response

Errors