Skip to content

List Connections

Diving Deep?

This page is designed for AI Agents & users developing code directly. See Getting Started and Platform Guides

GET /api/v1/connections

List all connections in the current org scope.

curl https://api.shipp.ai/api/v1/connections?api_key=$api_key

const apiKey = "YOUR_API_KEY_HERE";
const url = `https://api.shipp.ai/api/v1/connections?api_key=${apiKey}`;

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  },
});

const result = await response.json();

import requests

url = "https://api.shipp.ai/api/v1/connections"
api_key = "YOUR_API_KEY_HERE"

params = {
    "api_key": api_key
}

response = requests.get(url, params=params)

Response (200)

{
  "connections": [
    {
      "connection_id": "01KFXTX1WDQ68A1GS77T1XJ5YB",
      "enabled": true,
      "name": "string (optional)",
      "description": "string (optional)"
    }
  ]
}

Errors

  • 500: unexpected server error