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
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
Logo
Log inBook a demo
API ReferenceConnections

List Partner Shared Connections

GET
https://app.polytomic.com/api/organizations/:org_id/connections/:connection_id/shared
GET
/api/organizations/:org_id/connections/:connection_id/shared
$curl https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/connections/248df4b7-aa70-47b8-a036-33ac447e668d/shared \
>     -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 shared copies of a connection owned by a specific organization in the partner account. The `org_id` must match the organization that owns the parent connection. If it does not, the endpoint returns `404` rather than exposing information about the parent connection. This endpoint is useful in partner workflows where the parent connection is in the partner owner organization and the caller needs to audit which child organizations already have a shared copy.
Was this page helpful?
Previous

Create Partner Shared Connection

Next

Lists shared copies of a connection owned by a specific organization in the partner account.

The org_id must match the organization that owns the parent connection. If it does not, the endpoint returns 404 rather than exposing information about the parent connection.

This endpoint is useful in partner workflows where the parent connection is in the partner owner organization and the caller needs to audit which child organizations already have a shared copy.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

org_idstringRequiredformat: "uuid"
Unique identifier of the organization that owns the parent connection.
connection_idstringRequiredformat: "uuid"
Unique identifier of the parent connection whose shared copies should be listed.

Headers

X-Polytomic-VersionstringOptional

Response

OK
datalist of objects or null

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error