Get Integration Instance
GET/api/pinnacle/instances/:instance
Returns one Pinnacle integration instance: connection details (secrets redacted to presence flags), dispatch settings, the webhook URL + last 4 of the inbound key, connection health (connection_state is connected, token_expired, not_verified or incomplete; mreq_last_24h counts Pinnacle rate-limit rejections in the last 24 hours) and the last order sync time.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: requires a Bearer token (Personal Access 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.