Ability to see if a field is hidden

[woutdegeyter]

We see that we are able to list all the end user's fields using your API (for instance for Contacts we use https://rest91.bullhornstaffing.com/res ... entContact).
However this endpoint doesn't show us which fields are marked as "Hidden" in the Field Mappings admin.

We are an integration platform an would like to show to our end users a list of their fields (so they can set up field mappings for these fields). It would make sense for us to only present the end user with the fields which are not marked as Hidden as these are the only ones he will actually have relevant data for.
If we can't do this, it's more annoying for the end user for the following reasons:
a) It makes it more difficult for him to find his fields. They will need to scroll through all their unused custom fields (which will have names they've never heard of).
b) Some hidden field can have the same name as an exposed field, which will make it impossible for and end user to know which one to select. Note that this is already the case for the Contact "Address" label (used for the "address1" and "secondaryAddress1" fields).

Is there a possibility you could implement one of the below options, so we can filter out the hidden fields:
a) add a "hidden" boolean attribute on the meta API endpoints
b) add a request filter parameter on the meta API endpoints that allows to only show non-hidden fields
?

[DanJSupport]

Hi woutdegeyter,

The field being hidden or not is already available in the meta response.

Code: Select all

GET /meta/ClientContact?fields=*&meta=full

If you request the full meta with this call you will see the readOnly value. If it is set to true, the field is hidden.

[woutdegeyter]

Thanks for the quick feedback.
This indeed seems to be exactly what we were looking for!

[woutdegeyter]

Hi there,

This was exactly what we needed, thanks for the quick feedback!

Kind regards,
Wout