List Connections | Polytomic Docs

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

{
  "result": [
    {
      "id": "conn_9f8b7c6d-1234-4a56-8e9f-0a1b2c3d4e5f",
      "name": "Salesforce Production",
      "type": "salesforce",
      "createdAt": "2024-04-10T09:15:00Z",
      "updatedAt": "2024-05-01T12:00:00Z",
      "status": "active",
      "config": {
        "username": "admin@salesforce.com",
        "instanceUrl": "https://login.salesforce.com",
        "apiVersion": "v52.0"
      }
    },
    {
      "id": "conn_4a3b2c1d-5678-4e90-b123-456789abcdef",
      "name": "Postgres Analytics DB",
      "type": "postgres",
      "createdAt": "2023-11-20T16:45:00Z",
      "updatedAt": "2024-05-02T08:30:00Z",
      "status": "active",
      "config": {
        "host": "analytics-db.company.com",
        "port": 5432,
        "database": "analytics",
        "user": "readonly_user"
      }
    }
  ]
}

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.

Authentication

AuthorizationBasic

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

AuthorizationBearer

This is the Polytomic API key

Response

errorany

resultany

Errors

401

Unauthorized Error

500

Internal Server Error

Authentication

Headers

Response

Errors