V3 Get Business Contacts Category Fields

get

https://api.elliemae.com/encompass/v3/settings/contacts/businessContacts/customCategoryFields

Use this API to retrieve a list of custom category fields currently configured for Business Contacts in Encompass Settings.

This API added with the 25.1 release of Encompass.

Query Params

categories

string

The titles of the categories returned.

categoryIds

string

The unique identifier for each category returned.

includeEmpty

boolean

Indicate True to return to all custom category fields including fields not configured. Default is False.

ignoreInvalidCategories

boolean

If the parameter is set to False, the API will not ignore invalid category names or IDs, and the API will return an error. If the query parameter is not passed or is set to True, the API will ignore invalid category names or IDs. The default is True.

includeLegacyId

boolean

Indicate True to return the Legacy ID. Default value is False. Use this Legacy ID to update custom category fields using the V1 Update a Business Contact API. The custom category field IDs are different between V1 and V3 business contact-related APIs.

start

integer

Starting index for pagination. Default is 0.

limit

integer

Limiting index for pagination. Default limit is 10. Maximum limit is 100.

Headers

Authorization

string

required

Bearer token.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

200OK