Fetch payroll-relevant employee census fields in batches by Bob employee ID.
Partner OAuth integrations only
The Background Checks API is for approved HiBob Marketplace partners with Developer Portal access and OAuth credentials. Service users are not supported for this integration.
Bob customers building integrations for their own company should use Service users and the general Hiring API, not this partner contract.
Before you begin
- Read Integrate with Retirement Partners API to learn how to use this API.
Use this endpoint when you already have Bob employeeIds (from a pay cycle, webhook, or the employer roster) and need payroll-related profile fields. To discover who is assigned to an employer, use List employer employees under Employers.
Retirement Partners API endpoints
| Resource | Endpoint |
|---|---|
| Employee census | Get employee census data |
Rate limiting
Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.
| Method | Endpoint | Limit |
|---|---|---|
| GET | Get employee census data | 5 requests per minute |
Pass up to 25 employeeIds per request. Employees outside the caller's authorized scope are omitted from the response.
Required permissions and scopes
To use this endpoint, your OAuth app requires the following scope:
| Name | Scope | Description |
|---|---|---|
| Payroll Hub > Partner integration > Fetch pay cycle metadata, paystub information, and payroll-related employee data | payrollhub.payroll:read | Read payroll-related employee census fields. |