[BETA] Get 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.

  1. 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:read scope. There are no path or query parameters and no request body.
  2. Each item in items is one integration (integrationId, integrationName). Each entry in fields has a vendorFieldName that matches the keys in sync record data from Get sync report data—including pre-mapped table field IDs (Entitlement, Deduction, Variable pay, Actual payment).
  3. For each field, type is the partner-facing type. For list, multi-list, and hierarchy-list, values lists allowed options when available; for other types values is omitted.
  4. Partner-facing types align with Bob's public Fields metadata field types.

Rate limit: 5 requests per minute per auth.

Responses

Language
Credentials
Bearer
OAuth 2.0
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json