get
https://api.hibob.com/v1/payroll/hub/integrations/metadata
[BETA] MVP for Payroll Hub API for Partners.
Use this endpoint to fetch the field type and value catalog for your Payroll Hub integrations. Call it during integration setup (after you configure vendor fields in Payroll Connect) to learn which vendor field names exist, their partner-facing types, and—for list fields—allowed values, so you can correctly interpret sync record data payloads.
- Call this endpoint with a Bearer token for a company that has a Payroll Hub partner integration (or a Payroll Connect setup-stage integration). Your OAuth app needs the
company.metadata:readscope. There are no path or query parameters and no request body. - Each item in
itemsis one integration (integrationId,integrationName). Each entry infieldshas avendorFieldNamethat matches the keys in sync recorddatafrom Get sync report data—including pre-mapped table field IDs (Entitlement, Deduction, Variable pay, Actual payment). - For each field,
typeis the partner-facing type. Forlist,multi-list, andhierarchy-list,valueslists allowed options when available; for other typesvaluesis omitted. - Partner-facing types align with Bob's public Fields metadata field types.
Rate limit: 5 requests per minute per auth.

