GET
https://spark.test.woodcore.co/api/v2
/
loans
curl --request GET \
  --url https://spark.test.woodcore.co/api/v2/loans \
  --header 'Authorization: Bearer <token>'
{}

​
List All Loan Accounts

This allows the retrieval of all loan account in a paginated or non-paginated format.

Optional Query Parameters
NameDescriptionRequiredType
offsetPagination, index to start searching at when retrieving elements, used in combination with limit to paginate resultsfalseInteger
limitPagination, the number of elements to retrieve, used in combination with offset to paginate resultsfalseInteger
sortByThe criteria based on which the records will be sorted. Expected format is , e.g., sortBy = field1:ASC,field2:DESC.falseString
orderByone of displayName, accountNo, officeId, officeNameOrders. Filters the results by the field indicated.falseString
officeIdProvides ability to restrict list of loans returned based on the office there associated with.falseInteger
accountNoUse account no. of loans to restrict results.falseString

Example Requests:

baseUrl/api/v2/loans

baseUrl/api/v2/loans?fields=accountNo

baseUrl/api/v2/loans?offset=10&limit=50

baseUrl/api/v2/loans?orderBy=accountNo&sortOrder=DESC

​
Parameters

  • status (query, string, required: False): Example: Active

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
string
Example:

"Active"

Response

200 - application/json

ddddd

The response is of type object.