v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Org Connections

List Org Connections

Returns a list of org connections.

get/api/v2/org_connections

Query parameters

sink_org_idstring

The Org ID of the sink org.

source_org_idstring

The Org ID of the source org.

limitinteger

The limit of number of entries you want to return. Default is 1000.

offsetinteger

The pagination offset which you want to query from. Default is 0.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "connection_types": [
          "logs",
          "metrics"
        ],
        "created_at": "2023-01-01T12:00:00Z"
      },
      "id": "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a",
      "relationships": {
        "created_by": {
          "data": {
            "id": "usr123abc456",
            "name": "John Doe",
            "type": "users"
          }
        },
        "sink_org": {
          "data": {
            "id": "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a",
            "name": "Example Org",
            "type": "orgs"
          }
        },
        "source_org": {
          "data": {
            "id": "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a",
            "name": "Example Org",
            "type": "orgs"
          }
        }
      },
      "type": "org_connection"
    }
  ]
}