v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Connections

List Current Org Shared Connections

Lists shared copies of a connection that the caller's organization owns.

The returned connections are the child copies, not the parent connection itself. This is useful when a partner workflow needs to confirm which downstream organizations have already received a shared copy.

Creating a new shared copy is a separate operation. Use POST /api/organizations/{org_id}/connections/{connection_id}/share for the v5 partner-scoped flow.

get/api/connections/{id}/shared

Path parameters

idstring uuid required

Unique identifier of the parent connection whose shared copies should be listed.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the parent connection whose shared copies should be listed.

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"
      }
    }
  ]
}