Get Shiptheory Instance
GET/api/shiptheory/:integration_instance
Returns a single Shiptheory integration instance together with a live dashboard summary: per-status order counts, KPI totals (awaiting booking, booked last 7 days, failed, ignored), entity counts, per-entity last-sync timestamps, and the connection state. The stored password is never returned — only the account email and a has_password flag.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path parameter:
- integration_instance: the numeric id of the Shiptheory integration instance.
Authentication: requires a Bearer token.
Returns 404 when the instance does not exist.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.