Overview

Merge's Show Enum Origins feature lets you obtain the value of a Common Model enum field in the original format Merge received it from the third-party. It's available on all Common Model API endpoints where enum fields are relevant.

When you pass a Common Model enum field's name into the show_enum_origins query parameter, Merge replaces the normalized enum value in the response with the unnormalized value from the third-party. Use this when you want to surface the original third-party value while still accessing it via Merge's Common Model field, so the field is reliably present regardless of the integration.

How does show_enum_origins work?

Below is an example response from Merge's /employees endpoint where employment_status was passed into the query parameters. Instead of returning the normalized enum value INACTIVE in the employment_status field, Merge returns the original value Terminated as it was received from the third-party.

{
   "id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
   "remote_id": "19202938",
   "employee_number": "2",
   "display_full_name": "Cousin Greg Hirsch",
   "employment_status": "Terminated",
   ...
}

What are some example use cases?

• Group types and cost centers (most common) — GET /groups?show_enum_origins=type returns the raw Group Types and Cost Centers so your customers can identify which Cost Center to map in-product.

• Employment statuses — GET /employees?show_enum_origins=employment_status returns the non-normalized Employment Statuses for all Employees.

• Ticket statuses — GET /tickets?show_enum_origins=status returns the non-normalized Ticket Statuses for all Tickets.

What does an example cURL look like?

curl 'https://api.merge.dev/api/ticketing/v1/tickets?show_enum_origins=status' \
-H 'Authorization: Bearer [Insert your API key]' \
-H 'X-Account-Token: [Insert your Account token]'

Who should I contact for help?

If you have questions about show_enum_origins or want help identifying which Common Model fields support it, reach out to us at [email protected].