V1 Get Borrower Contact List

Retrieve borrower contacts. Use the start and limit parameters to control size and start point of the response page.

Usage Notes

  • The cursor expires after 5 minutes of inactivity. However, with continuous use, you can keep the cursor alive up to a maximum of 12 hours.
  • 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.
  • The cursorType is randomAccess which allows you to randomly assign a start position to start the pagination to retrieve data for the specified cursor.
  • When specifying a cursorType, the request can only include a filter attribute.
Query Params
string

Starting index or record number from which to retrieve the contacts. The default is 1.

string

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.

string

cursorType is randomAccess. Required only for pagination.

Body Params
fields
array of strings

List of business contact fields to query.
Provide the canonical field names for the contact.

fields
string

Type of loans to query. Possible values are:

None

AnyClosed

LastClosed

AnyOriginated

  • LastOriginated
Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
Response
Choose an example:
application/json