Skip to main content
GET
List advances

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Query Parameters

limit
number
default:25

Page size (1–100).

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response’s meta.next_cursor.

status
enum<string>

Only advances with this status.

Available options:
on-track,
missed-payments,
defaulted,
paid-off
lender_id
string

Only advances funded by this lender.

business_id
string

Only advances on deals of this business.

renewal_ready
boolean

true = only advances whose paid-in percentage has reached the renewal threshold (location default or per-advance override) and that are not paid off. false = the rest.

Response

OK

data
object[]
required
meta
object
required