### Loan Pipeline Query Examples
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/view-pipeline-with-pagination-1
Examples of JSON request bodies used to query the loan pipeline. These demonstrate how to specify fields, sort orders, and complex filter criteria for retrieving loan GUIDs.
```json
{
"fields": ["Loan.LoanFolder", "Fields.4000", "Loan.LoanNumber"],
"sortOrder": [{"canonicalName": "Loan.LastModified", "order": "Descending"}],
"filter": {
"canonicalName": "Loan.LastModified",
"value": "02/25/2018",
"matchType": "greaterThanOrEquals"
},
"includeArchivedLoans": "true"
}
```
--------------------------------
### GET /settings/configuration
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-users-effective-rights
Retrieves the current configuration settings for loan processing, document setup, and secondary market parameters.
```APIDOC
## GET /settings/configuration
### Description
Retrieves the comprehensive configuration object including loan processing flags, document setup options, and secondary market automation settings.
### Method
GET
### Endpoint
/settings/configuration
### Request Body
N/A
### Response
#### Success Response (200)
- **ConditionForms** (boolean) - Status of condition forms configuration.
- **DocsSetup** (object) - Configuration object for document disclosure and closing templates.
- **SecondarySetup** (object) - Configuration object for secondary market settings like Auto-Lock.
#### Response Example
{
"ConditionForms": true,
"DocsSetup": {
"ParentAccess": true,
"eDisclosurePackages": true,
"ComplianceAuditSettings": true
},
"SecondarySetup": {
"Auto-Lock": true
}
}
```
--------------------------------
### GET /configuration/settings
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-users-effective-rights
Retrieves the current configuration settings for loan features, contact setup, and business rules.
```APIDOC
## GET /configuration/settings
### Description
Retrieves a comprehensive list of boolean flags for system features including loan settings, contact management, and business rules.
### Method
GET
### Endpoint
/configuration/settings
### Request Body
N/A
### Response
#### Success Response (200)
- **LoanSettings** (object) - Configuration flags for loan-related features (e.g., LOCompensation, Escrow).
- **ContactSetup** (object) - Configuration flags for contact management (e.g., EmailServerSettings, BorrowerCustomFields).
- **BusinessRules** (object) - Configuration flags for automated business logic (e.g., CollateralTracking, MilestoneCompletion).
#### Response Example
{
"LoanSettings": {
"LOCompensation": true,
"Escrow": true
},
"ContactSetup": {
"EmailServerSettings": true,
"BorrowerCustomFields": true
},
"BusinessRules": {
"CollateralTracking": true,
"MilestoneCompletion": true
}
}
```
--------------------------------
### Example Encompass Settings and Options
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-client-settings
Provides an example of how Encompass settings and associated options might be structured. This includes settings like skipping income and assets, allowing locks, and enabling/disabling specific features.
```json
{
"options": {
"skipIncome": true,
"skipAssets": true,
"allowLock": true,
"roundCorr": true,
"roundBroker": true,
"noClosingCost": true,
"flagged": true,
"isMIQuotesEnabled": false
},
"encompassSettings": {
"changeEffectiveDateOnReLock": true,
"changeProgramOnReLock": true,
"changeAdditionalLoanProg": false
},
"productTypes": null
}
```
--------------------------------
### Retrieve Custom Print Forms List (OpenAPI)
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-encompass-v3-settings-loan-customprintforms
This snippet defines the OpenAPI specification for retrieving a list of custom print forms. It details the GET request, parameters like 'level', 'limit', 'start', and 'path', and the structure of the 200 OK response, including example data.
```json
{
"openapi": "3.1.0",
"info": {
"version": "1.0",
"title": "Settings: Loan Setup",
"summary": "Use these APIs to manage and retrieve various loan setup configurations.",
"description": "Use these APIs to manage and retrieve various loan setup configurations."
},
"servers": [
{
"url": "https://api.elliemae.com",
"description": "Production"
},
{
"url": "https://concept.api.elliemae.com",
"description": "UAT"
}
],
"paths": {
"/encompass/v3/settings/loan/customPrintForms": {
"get": {
"tags": [
"Loan Print Forms"
],
"summary": "V3 Get List of Custom Print Forms",
"description": "Retrieves a list of custom print form settings.\r\n\r\n> _This API added with the 25.1 release of Encompass._",
"operationId": "get-encompass-v3-settings-loan-customPrintForms",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"name": "level",
"in": "query",
"description": "Indicates whether to retrieve contents of top-level folder only or include contents of child folders recursively. Possible values are the following:
**Top** (The default is Top.)
**All**",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "Limiting index for pagination. Default limit is 10. Maximum limit is 1000.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "start",
"in": "query",
"description": "Starting index for pagination. Default is 0.",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "path",
"in": "query",
"description": "The path of the folder from which to retrieve the contents.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintFormsContracts"
},
"examples": {
"Model Data Sample": {
"value": {
"name": "string",
"path": "string",
"parent": {
"entityId": "string",
"entityName": "string",
"entityUri": "string",
"entityType": "Default",
"entityPath": "string",
"itemizationType": "string",
"description": "string",
"hasSubFolders": true,
"fileName": "string"
},
"contents": [
{
"entityId": "string",
"entityName": "string",
"entityUri": "string",
"entityType": "Default",
"entityPath": "string",
"itemizationType": "string",
"description": "string",
"hasSubFolders": true,
"fileName": "string"
}
]
}
},
"Live Data Sample": {
"value": {
"name": "Public Custom Print Forms",
"path": "Public:\\",
"contents": [
{
"entityName": "Companywide",
"entityType": "CustomPrintFormFolder",
"entityPath": "Public:\\Companywide\\",
"hasSubFolders": true
},
{
"entityName": "Folder-1",
"entityType": "CustomPrintFormFolder",
"entityPath": "Public:\\Companywide\\Folder-1\\",
"hasSubFolders": false
},
{
"entityName": "Test-Cust-Form-1",
"entityType": "CustomPrintForm",
"entityPath": "Public:\\Companywide\\Folder-1\\Test-Cust-Form-1.DOC",
"fileName": "Test-Cust-Form-1.DOC"
}
]
}
}
}
}
}
}
}
}
}
}
}
```
--------------------------------
### Task Template Configuration Example
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/update-task-settings
An example instance of a task template configuration object. This demonstrates how to populate the schema with specific values for dispositions and visibility settings.
```json
{
"dispositionConfigurations": {
"entityType": "string",
"enable Disposition": true,
"dispositions": [
{ "commentRequired": true, "name": "string" }
],
"default Disposition": "string"
},
"visibilityConfiguration": {
"completed SubTasksCount": "Show",
"priority": "Show",
"dueDateTime": "Hide"
}
}
```
--------------------------------
### Retrieve Other Liabilities (Node.js)
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/liabilities
This Node.js example shows how to fetch other liabilities using the V3 API. It utilizes the 'axios' library to make a GET request, passing the loanId and applicationId in the URL and the authorization token in the headers. Ensure 'axios' is installed.
```JavaScript
const axios = require('axios');
const getOtherLiabilities = async (loanId, applicationId, token) => {
try {
const response = await axios.get(`https://api.elliemae.com/encompass/v3/loans/${loanId}/applications/${applicationId}/otherLiabilities`, {
headers: {
'Authorization': `Bearer ${token}`,
'accept': 'application/json'
}
});
return response.data;
} catch (error) {
console.error('Error fetching other liabilities:', error);
throw error;
}
};
// Example usage:
// const loanId = 'your_loan_id';
// const applicationId = 'your_application_id';
// const token = 'your_bearer_token';
// getOtherLiabilities(loanId, applicationId, token).then(data => console.log(data));
```
--------------------------------
### Get List of Roles (OpenAPI)
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-a-list-of-roles
Defines the GET endpoint for retrieving a list of roles from the Encompass instance. It specifies the response schema, including role details like ID, name, abbreviation, associated personas, and user groups. Includes example responses for both model data and live data.
```json
{
"openapi": "3.1.0",
"info": {
"version": "1.0",
"title": "Settings: Company/User Setup",
"summary": "Retrieve and manage various company and user settings.",
"description": "Use these APIs to retrieve and manage the following Encompass settings:\r\n\r\n- Milestones\r\n- Organizations\r\n- Personas\r\n- Roles"
},
"servers": [
{
"url": "https://api.elliemae.com",
"description": "Production"
},
{
"url": "https://concept.api.elliemae.com",
"description": "UAT"
}
],
"paths": {
"/encompass/v1/settings/roles": {
"get": {
"tags": [
"Roles"
],
"summary": "V1 Get a List of Roles",
"description": "Returns a list of Roles that are defined on the Encompass instance.\r\n\r\n\r\n> 📘 \r\n> A roleID of \"**-1**\" equates to the text value of \"**Others**\" in Encompass desktop (f.k.a., SmartClient).\r\n",
"operationId": "get-a-list-of-roles",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleContract"
},
"examples": {
"Model Data Sample": {
"value": [
{
"protected": true,
"roleAbbr": "string",
"roleID": 0,
"roleName": "string",
"personas": [
{
"name": "string",
"id": 0
}
],
"userGroups": [
{
"groupId": 0,
"groupName": "string"
}
]
}
]
},
"Live Data Sample": {
"value": [
{
"protected": true,
"roleAbbr": "LO",
"roleID": 1,
"roleName": "Loan Officer",
"personas": [
{
"name": "Loan Officer",
"id": 7
},
{
"name": "TPO Admins",
"id": 24
}
],
"userGroups": [
{
"groupId": 1,
"groupName": "All Users"
},
{
"groupId": 12,
"groupName": "TPO Admins"
}
]
},
{
"protected": false,
"roleAbbr": "TO",
"roleID": 16,
"roleName": "TPOLO",
"personas": [
{
"name": "TPO Admins",
"id": 24
}
],
"userGroups": [
{
"groupId": 1,
"groupName": "All Users"
},
{
"groupId": 12,
"groupName": "TPO Admins"
}
]
},
{
"protected": false,
"roleAbbr": "AE",
"roleID": 18,
"roleName": "TPO AE",
"personas": [
{
"name": "TPO Admins",
"id": 24
}
],
"userGroups": [
{
"groupId": 1,
"groupName": "All Users"
}
]
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
}
}
}
}
}
}
```
--------------------------------
### Task Live Data Sample
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-tasks
Provides a concrete example of a task object populated with sample data, demonstrating the usage of custom attributes, associations, and status fields.
```json
{
"id": "Task Id",
"name": "Task name",
"description": "Task description",
"type": "Task type",
"taskGroupId": "Task Group Guid",
"customAttributes": [
{ "KEY 1": "VALUE 1" },
{ "KEY 2": "VALUE 2" }
],
"associations": [
{
"entityId": "Guid",
"entityType": "TypeURN",
"relationship": "relationship"
}
],
"workEntity": {
"entityType": "TypeURN",
"entityId": "guid"
},
"autocomplete": "true",
"status": "COMPLETED",
"resolution": "Waived",
"assignee": {
"entityType": "TypeURN",
"entityId": "ObjectID"
},
"due": "2021-08-27 16:57:04Z"
}
```
--------------------------------
### Get a Loan Custom Field (OpenAPI)
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-a-custom-field
This OpenAPI definition describes the GET endpoint for retrieving a specific loan custom field. It specifies the request parameters, including authorization and the custom field ID, and outlines the possible responses, including a 200 OK with a detailed schema and examples of model and live data.
```json
{
"openapi": "3.1.0",
"info": {
"version": "1.0",
"title": "Settings: Loan Setup",
"summary": "Use these APIs to manage and retrieve various loan setup configurations.",
"description": "Use these APIs to manage and retrieve various loan setup configurations."
},
"servers": [
{
"url": "https://api.elliemae.com",
"description": "Production"
},
{
"url": "https://concept.api.elliemae.com",
"description": "UAT"
}
],
"paths": {
"/encompass/v1/settings/loan/customFields/{customFieldId}": {
"get": {
"tags": [
"Loan Custom Fields"
],
"summary": "V1 Get a Custom Field",
"description": "Returns the loan schema for the specified loan custom field.",
"operationId": "get-a-custom-field",
"parameters": [
{
"$ref": "#/components/parameters/Authorization"
},
{
"name": "customFieldId",
"in": "path",
"description": "The custom field ID of the schema to return.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V1LoanCustomFields"
},
"examples": {
"Model Data Sample": {
"value": {
"id": "string",
"description": "string",
"format": "string",
"maxLength": 0,
"calculation": "string",
"audit": {
"fieldId": "string",
"data": "string"
},
"options": [
"string"
],
"modelPath": "string",
"isCalculatedField": true
}
},
"Live Data Sample": {
"value": [
{
"id": "CUST01FV",
"description": "cust01fv",
"format": "DROPDOWNLIST",
"maxLength": 0,
"options": [
"cs1s1",
"cs1s2"
],
"modelPath": "Loan.CustomFields[(FieldName == 'CUST01FV')].StringValue",
"isCalculatedField": true
},
{
"id": "CUST02FV",
"description": "cust02fv",
"format": "DROPDOWNLIST",
"maxLength": 0,
"options": [
"cs2s1",
"cs2s2"
],
"modelPath": "Loan.CustomFields[(FieldName == 'CUST02FV')].StringValue",
"isCalculatedField": false
},
{
"id": "CUST03FV",
"description": "",
"format": "NONE",
"maxLength": 0,
"modelPath": "Loan.CustomFields[(FieldName == 'CUST03FV')].StringValue",
"isCalculatedField": false
}
]
}
}
}
}
},
"400": {
"description": "Bad Request"
}
},
"servers": [
{
"url": "https://api.elliemae.com",
"description": "Production"
},
{
"url": "https://concept.api.elliemae.com",
"description": "UAT"
}
]
}
}
},
"components": {
"parameters": {
"Authorization": {
"name": "Authorization",
"in": "header",
"description": "Bearer token.",
"required": true,
"schema": {
"type": "string"
}
}
},
"schemas": {
"V1LoanCustomFields": {
"type": "object",
"title": "V1LoanCustomFieldAttributes",
"properties": {
"id": {
"type": "string",
"description": "Loan custom field name."
},
"description": {
"type": "string",
"description": "Description for loan custom field."
},
"format": {
"type": "string"
}
}
}
}
}
}
```
--------------------------------
### User Provisioning (POST /Users)
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/create-user
This section describes the structure for creating a new user via the SCIM API. It includes details on the core user schema and the ICE MT product-specific schema extensions.
```APIDOC
## POST /Users
### Description
Creates a new user within the ICE MT system. This endpoint supports SCIM core user schema and various ICE MT product-specific schema extensions.
### Method
POST
### Endpoint
/Users
### Parameters
#### Request Body
- **schemas** (array) - Required - An array of schema URIs. Must include 'urn:ietf:params:scim:schemas:core:2.0:User' and relevant ICE MT product schemas.
- **urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser** (object) - Optional - Defines properties specific to AIQ users.
- **userName** (string) - Required - Unique identifier for the user. Max length: 50. Takes precedence if also in core schema.
- **roleName** (string) - Optional - The user's role.
- **enabled** (boolean) - Required - Indicates if the user is enabled for application access.
- **name** (object) - Required - User's name components.
- **familyName** (string) - Required - User's last name.
- **middleName** (string) - Optional - User's middle name.
- **givenName** (string) - Required - User's first name.
- **phoneNumbers** (array) - Optional - Array of phone number objects.
- **emails** (array) - Required - Array of email objects.
- **ssoOnly** (boolean) - Optional - Enables SSO login. Defaults to true.
- **authId** (string) - Required if ssoOnly is true - The SSO provider or authentication ID.
- **urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser** (object) - Optional - Defines properties specific to Encompass Internal users.
- **id** (string) - Optional - User ID.
- **userName** (string) - Required - Unique identifier for the user. Cannot start with '.'. Certain characters are disallowed. Max length: 16.
- **name** (object) - Optional - User's name components.
### Request Example
```json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser"
],
"urn:ietf:params:scim:schemas:extension:ice:2.0:AIQUser": {
"userName": "",
"roleName": "UnderWriter",
"enabled": true,
"name": {
"familyName": "",
"givenName": ""
},
"emails": [
{
"value": "user@example.com",
"type": "work"
}
],
"ssoOnly": true,
"authId": "09DD0355-F072-321D-4A65-430FF1C7C102"
}
}
```
### Response
#### Success Response (201 Created)
- **schemas** (object) - Schemas used for the user provisioning.
- **id** (string) - Global UserId for ICE MT products.
- **urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser** (object) - Details of the Encompass Internal User.
- **id** (string) - User ID.
- **userName** (string) - Unique identifier of the user.
- **name** (object) - User's name components.
#### Response Example
```json
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser"
],
"id": "",
"urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser": {
"id": "",
"userName": ""
}
}
```
```
--------------------------------
### Configure Input Forms and Other Miscellaneous Settings
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-users-effective-rights
This configuration snippet includes settings for input forms, such as a checkbox to show all forms, and other miscellaneous options like instant messenger status and thin/thick client access to pipeline and trades tabs. It also covers settings for loan management duplication.
```json
{
"Miscellaneous": {
"InputForms_ShowAllFormsCheckBox": false,
"InstantMessenger": false,
"ThinThick_PipelineTab_Access": false,
"ThinThick_TradesTab_Access": false,
"LoanMgmt_Duplicate_Blank": false
}
}
```
--------------------------------
### V1 Get Business Contact List - OpenAPI Definition
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-business-contact-list
This snippet defines the OpenAPI specification for the 'V1 Get Business Contact List' endpoint. It includes details on the HTTP method (POST), summary, description, operation ID, parameters (Authorization, start, limit), request body schema, and example responses. The endpoint retrieves borrower contacts and allows pagination.
```json
{
"openapi": "3.1.0",
"info": {
"title": "ICE Mortgage Technology",
"version": "1.0"
},
"servers": [
{
"url": "https://api.elliemae.com"
}
],
"security": [
{}
],
"paths": {
"/encompass/v1/businessContactSelector/": {
"post": {
"summary": "V1 Get Business Contact List",
"description": "Retrieve borrower contacts. Use the **start** and **limit** parameters to control size and start point of the response page.",
"operationId": "get-business-contact-list",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer token",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start",
"in": "query",
"description": "Starting index or record number from which to retrieve the contacts. The default is 1.",
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query',
"description": "The maximum number of records to return in a page. Response size is limited to 6 MB and is recalculated if the response exceeds 6 MB. The default value is 1000. The maximum value is limited to 10000.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"fields": {
"type": "string",
"description": "Business contact query object. Use the data provided in the [Business Contact Query Attributes table](https://developer.icemortgagetechnology.com/developer-connect/reference/contracts#business-contact-attributes).",
"default": "[ \"Contact.AccessLevel\", \"ContactOwner.UserName\" ]",
"format": "json"
}
}
},
"examples": {
"Request Example": {
"value": {
"fields": [
"Contact.AccessLevel",
"ContactOwner.UserName",
"ContactCategory.CategoryName",
"ContactGroupCount.GroupCount",
"ContactLoanCount.LoanCount",
"ContactCompleteLoanCount.LoanCount",
"Contact.FirstName",
"Contact.LastName",
"Contact.CompanyName",
"Contact.JobTitle"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "[
{
\"id\": \"9f641d8d-984b-4733-a739-913eac59fce6\",
\"fields\": {
\"Contact.AccessLevel\": \"Public\",
\"ContactOwner.UserName\": \"SatishK\",
\"ContactCategory.CategoryName\": \"Credit Company\",
\"ContactGroupCount.GroupCount\": \"\",
\"ContactLoanCount.LoanCount\": \"8\",
\"ContactCompleteLoanCount.LoanCount\": \"2\",
\"Contact.FirstName\": \"Test Contact FName\",
\"Contact.LastName\": \"Test Contact LName\",
\"Contact.CompanyName\": \"ABC Solutions\",
\"Contact.JobTitle\": \"Software Engineer\"
}
},
{
\"id\": \"aa334e89-dadc-4e9a-9b80-5f26d4fd1890\",
\"fields\": {
\"Contact.AccessLevel\": \"Private\",
\"ContactOwner.UserName\": \"user, admin\",
\"ContactCategory.CategoryName\": \"Attorney\",
\"ContactGroupCount.GroupCount\": \"2\",
\"ContactLoanCount.LoanCount\": \"1\",
\"ContactCompleteLoanCount.LoanCount\": \"\",
\"Contact.FirstName\": \"Jenn\",
\"Contact.LastName\": \"Shaw\",
\"Contact.CompanyName\": \"Lender Company\",
\"Contact.JobTitle\": \"\"
}
}
]
"
}
},
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "9f641d8d-984b-4733-a739-913eac59fce6"
},
"fields": {
"type": "object",
"properties": {
"Contact.AccessLevel": {
```
--------------------------------
### Access Settings Configuration Example
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-an-external-user
This JSON snippet outlines the access settings for a user or entity. It includes configurations for 'peerLoanAccess' and 'accessMode', defining the level of access granted.
```json
{
"peerLoanAccess": "Disabled",
"accessMode": "ReadWrite"
}
```
--------------------------------
### V1 Get Business Contact List
Source: https://developer.icemortgagetechnology.com/developer-connect/reference/get-business-contact-list
Retrieve borrower contacts using the V1 Get Business Contact List endpoint. You can control the response page size and starting point with the 'start' and 'limit' parameters.
```APIDOC
## POST /encompass/v1/businessContactSelector/
### Description
Retrieve borrower contacts. Use the **start** and **limit** parameters to control size and start point of the response page.
### Method
POST
### Endpoint
https://api.elliemae.com/encompass/v1/businessContactSelector/
### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Bearer token
#### Query Parameters
- **start** (string) - Optional - Starting index or record number from which to retrieve the contacts. The default is 1.
- **limit** (string) - Optional - The maximum number of records to return in a page. Response size is limited to 6 MB and is recalculated if the response exceeds 6 MB. The default value is 1000. The maximum value is limited to 10000.
#### Request Body
- **fields** (array of strings) - Required - Business contact query object. Use the data provided in the [Business Contact Query Attributes table](https://developer.icemortgagetechnology.com/developer-connect/reference/contracts#business-contact-attributes).
### Request Example
```json
{
"fields": [
"Contact.AccessLevel",
"ContactOwner.UserName",
"ContactCategory.CategoryName",
"ContactGroupCount.GroupCount",
"ContactLoanCount.LoanCount",
"ContactCompleteLoanCount.LoanCount",
"Contact.FirstName",
"Contact.LastName",
"Contact.CompanyName",
"Contact.JobTitle"
]
}
```
### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the contact.
- **fields** (object) - An object containing various fields related to the business contact.
- **Contact.AccessLevel** (string) - The access level of the contact.
- **ContactOwner.UserName** (string) - The username of the contact owner.
- **ContactCategory.CategoryName** (string) - The name of the contact's category.
- **ContactGroupCount.GroupCount** (string) - The count of groups the contact belongs to.
- **ContactLoanCount.LoanCount** (string) - The count of loans associated with the contact.
- **ContactCompleteLoanCount.LoanCount** (string) - The count of completed loans associated with the contact.
- **Contact.FirstName** (string) - The first name of the contact.
- **Contact.LastName** (string) - The last name of the contact.
- **Contact.CompanyName** (string) - The company name of the contact.
- **Contact.JobTitle** (string) - The job title of the contact.
#### Response Example
```json
[
{
"id": "9f641d8d-984b-4733-a739-913eac59fce6",
"fields": {
"Contact.AccessLevel": "Public",
"ContactOwner.UserName": "SatishK",
"ContactCategory.CategoryName": "Credit Company",
"ContactGroupCount.GroupCount": "",
"ContactLoanCount.LoanCount": "8",
"ContactCompleteLoanCount.LoanCount": "2",
"Contact.FirstName": "Test Contact FName",
"Contact.LastName": "Test Contact LName",
"Contact.CompanyName": "ABC Solutions",
"Contact.JobTitle": "Software Engineer"
}
},
{
"id": "aa334e89-dadc-4e9a-9b80-5f26d4fd1890",
"fields": {
"Contact.AccessLevel": "Private",
"ContactOwner.UserName": "user, admin",
"ContactCategory.CategoryName": "Attorney",
"ContactGroupCount.GroupCount": "2",
"ContactLoanCount.LoanCount": "1",
"ContactCompleteLoanCount.LoanCount": "",
"Contact.FirstName": "Jenn",
"Contact.LastName": "Shaw",
"Contact.CompanyName": "Lender Company",
"Contact.JobTitle": ""
}
}
]
```
```