Download Postman Collection
API Reference

V3 Loan Pipeline (with Pagination)

post
https://api.elliemae.com/encompass/v3/loanPipeline

Retrieves pages of loan IDs (GUIDs) and specified fields from loans on the Pipeline.

Usage Notes

  • The limit query parameter may be overridden by the server. The server will calculate the optimal limit depending upon the requested number of loans and fields.
  • Only the fields attribute is accepted in the request body.
  • canonicalName in “Loan Pipeline” API maps to the canonicalName in “Get Canonical Names” response payload.
  • The number of loans in a page can be retrieved by reading the response.
  • A maximum of 1000 loans are returned per page.
  • The Precision element applies only to date/dateTime values.
Query Params
string
required

Zero-based starting index. The default is zero.

string
required

The maximum number of items to return. Please refer to the Usage Notes.

string

Additional data to include. The only possible value at this time is LockInfo.

boolean
Defaults to false

Indicates whether to ignore fields that are invalid in the request. Default is true. If specified as false, an error will be thrown if invalid fields are specified in the request payload.

Body Params
string

The query that you want to apply to the pipeline to retrieve loans. Use the data provided in the Loan Pipeline Query Contract.

Headers
string
required

Bearer token

Response

Updated over 1 year ago

Language
Response 
 Choose an example:
application/json
Updated over 1 year ago 


































© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use