List loan sub-statuses

get

https://api.lendingwise.com/api/v4/loan-sub-statuses

The sub-statuses your company has set up, arranged in categories. A
sub-status belongs to a category rather than to a particular top-level
status — there is no link between the two.

Pass categoryId to get one category on its own, or leave it out to
get all of them. Either way each item tells you its own categoryId,
so you can group them yourself. Each item's fileTypes lists the loan
types the sub-status can be used with, as ids from
/api/v4/loan-types.

Order. Sub-statuses come back in the order your company arranged
them in the LendingWise portal, matching what the portal itself shows:
by loan type, then category, then your own display order within that
grouping, then by name. A sub-status set up for several loan types
takes its position from the first one it belongs to. The order carries
meaning, so do not re-sort it unless you specifically want a different
one.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

categoryId

integer

Narrows the list to the sub-statuses in one category. Pass a categoryId from an item in this same list — there is no separate categories endpoint, so leave this out once to see which categories exist. A categoryId no category uses is not an error: you get 200 and an empty list, exactly as you would for a category that happens to have no sub-statuses. So an empty result never tells you the id was wrong.

fileType

string

length ≤ 10

Narrows the list to the sub-statuses set up for one loan type. Pass an id from /api/v4/loan-types, for example HMLO.

page

integer

≥ 1

Which page to return, counting from 1. Defaults to page 1.

Leaving this off does not return every row — every list on this API
is paged. See per_page for the size, and read
meta.pagination.perPage back rather than assuming it.

per_page

integer

1 to 100

How many rows you want per page, from 1 to 100.

Omitted, it falls back to a server-configured default (25 today).
Read the size actually applied from meta.pagination.perPage rather
than assuming this number — it is configuration, not contract, and it
has already changed once.

The number of rows in data is therefore the size of the PAGE, never
of the list. meta.pagination.total is the size of the whole list, so
a single call with per_page=1 sizes a list before you fetch it, and
hasMore says whether more remain.

Responses

200Your company's loan sub-statuses. The list can be empty.

400Your request body could not be read, so nothing was changed. error.details.reason says what the problem was.

401Your bearer token is missing, or it is not valid. Get a new one from POST /api/v4/authenticate and send it again.

415Your body is JSON, but it was not labelled as JSON, so it was not read and nothing was changed. Send it again with Content-Type: application/json.

422One or more of the values you sent cannot be used, so nothing was changed. error.fields names each field and says what was wrong.

429You have made too many calls, so this one was refused and nothing was changed. Retry-After says how many seconds to wait; sending the same request again after that works.

defaultAny other failure. The shape is the same as every other error reply, so the same code can read it.