API Reference

Diving Deep?

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

How to use the API¶

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

Base URL: https://api.shipp.ai/api/v1/

Authorization is required for all endpoints. The API Key is available in the dashboard.

All requests & responses are JSON.

Status Codes follow normal meaning, 2xx is success, 4xx is a client error, and 5xx are server errors