---
title: "Get connection status"
method: GET
path: "/payroll/hub/us/connection/status"
tags: ["Connection"]
---

# Get connection status

`GET /payroll/hub/us/connection/status`

## Request

- Base URL: `https://api.hibob.com/v1`
- URL: `https://api.hibob.com/v1/payroll/hub/us/connection/status`
- Auth: HTTP bearer

**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.

## Response `200`

Success

## Other responses

- `400`: Bad request — invalid request body, validation error, or deduction rejected by US Payroll.
- `401`: Unauthorized — the OAuth 2.0 access token is missing, invalid, or expired.
- `403`: Forbidden — the authenticated caller does not have permission to perform this operation on the requested company, employer, or employee.
- `429`: Too many requests — rate limit exceeded. Read the limit per operation (most reads are 5/minute, mutations 200/minute) and retry after the indicated delay.
- `500`: Internal server error — an unexpected error occurred. Retry with exponential backoff; if the error persists, contact HiBob support with the `requestId` from the response body.

---

[API](https://skmtc.dev/hibob/apis/retirement-partners-api.md) - [All operations](https://skmtc.dev/hibob/apis/retirement-partners-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hibob/apis/retirement-partners-api/revisions/5ebd2ae67958?raw)