Get Integration Instance
GET/api/shippo/instances/:integration_instance
Returns a Shippo integration instance: its name, masked API token, test/live mode, settings (auto_push_orders, record_shipping_costs, label_file_type plus the available label_file_type_options, sync_start_date, is_automatic_sync_enabled) and health/sync state (auth_error_at and is_healthy, last_synced_at, last_webhook_at, webhook_subscribed_at, webhook_events_registered).
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
The API token is never returned in full. Returns 404 when the id is not a Shippo integration instance.
Authentication: Requires a Bearer token.
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
Response Headers
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.