Get connection status

get

https://api.hibob.com/v1/payroll/hub/us/connection/status

Verify Retirement Partners API reachability for the authenticated caller.

Beta. Returns an empty JSON object when the Retirement Partners API is
reachable. The response may be cached briefly (max-age 60 seconds). Use during
partner onboarding and periodically to detect revoked access or configuration drift.

Rate limit: 5 requests per minute per authenticated caller.

Responses

200

Success

Language

Credentials

Bearer

OAuth 2.0

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad request — invalid request body, validation error, or deduction rejected by US Payroll.

401Unauthorized — the OAuth 2.0 access token is missing, invalid, or expired.

403Forbidden — the authenticated caller does not have permission to perform this operation on the requested company, employer, or employee.

429Too many requests — rate limit exceeded. Read the limit per operation (most reads are 5/minute, mutations 200/minute) and retry after the indicated delay.

500Internal server error — an unexpected error occurred. Retry with exponential backoff; if the error persists, contact HiBob support with the requestId from the response body.