New Legacy Report Field Map Endpoint

We added a companion to last month's ID map endpoint to help integrations finish the transition from legacy custom reports to our updated reporting infrastructure.

Get Legacy Report Field Map (GET /api/v1/custom-reports/legacy-field-map) returns a mapping from the field identifiers the deprecated Get Company Report endpoint returned to the field names the Custom Reports and Datasets endpoints use today. If your integration or automation still references legacy field identifiers, use this endpoint to look up the current name. A field that came back as location before report migration is jobInformationLocation afterward.

Key details:

• Each mapping pairs a legacyFieldId with the fieldName it now maps to, along with that field's fieldLabel, type, and entityName. The fieldName matches the key returned by Get Report by ID and Get Fields from Dataset, so it needs no further translation.
• Legacy time off, benefit, and training fields encoded a category in the field itself, so a legacy "Vacation" field returned only vacation hours. These map to a general field plus a qualifier you must apply as a filter. Requesting the mapped fieldName on its own returns every category rather than the one the legacy field returned.
• A legacy identifier can appear more than once, because the legacy report emitted an amount column and its currency-code column under a single identifier. payRate maps to both compensationPayRate and compensationPayRateCurrencyCode, so compare type or fieldLabel against the column you are replacing. An identifier that is absent has no equivalent field, and the migrated report doesn't contain that column either.
• The response is company-wide field metadata rather than report data, so it isn't scoped to your reports or your field permissions and a field appearing here doesn't mean you can read its data. The endpoint returns a 403 when the user doesn't have permission to manage reports.
• Supports both Basic Auth and OAuth 2.0 with the report scope.

To translate legacy report IDs rather than field identifiers, use Get Legacy Report ID Map.

Full documentation is available under Get Legacy Report Field Map.