Skip to main content
GET
List debtors

Authorizations

Authorization
string
header
required

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

Query Parameters

customer_number
string

Exact, case-sensitive customer number. A blank value is invalid.

Required string length: 1 - 50
email
string<email>

Exact, case-insensitive match on the current primary email shown in the debtor response. A blank or malformed value is invalid.

Required string length: 1 - 254
limit
integer
default:10

Number of results to return per page; defaults to 10.

Required range: 1 <= x <= 100
offset
integer
default:0

Zero-based index of the first result; defaults to 0.

Required range: x >= 0
ordering
string

Comma-separated sort fields: created or customer_number. Prefix a field with - for descending order. Defaults to -created (newest first); an unknown field returns 400 with invalid_parameter.

Response

count
integer
required

Total number of matching resources.

Example:

123

results
object[]
required

Resources returned for the requested page.

next
string<uri> | null

URL for the next page, or null on the last page.

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null

URL for the previous page, or null on the first page.

Example:

"http://api.example.org/accounts/?offset=200&limit=100"