Skip to main content

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.

Required scope: integrations:read

Grant 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​

OK

Response Headers
    Content-Type