Skip to main content
GET
/
borrowers
List all borrowers
curl --request GET \
  --url https://lms.tausi.africa/v1/borrowers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 123,
      "business_name": "<string>",
      "phone": "<string>",
      "address": "<string>",
      "type": "<string>",
      "region": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "country": "<string>",
      "email": "[email protected]",
      "credit_score": 123
    }
  ],
  "total": 123,
  "page": 123,
  "rowsPerPage": 123,
  "success": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer<int32>
default:1

Page number for pagination (defaults to 1).

Required range: x >= 1
​
rows
integer<int32>
default:100

Number of borrowers per page (default: 100, max: 100).

Required range: 1 <= x <= 100

Response

Successful response with borrower list.

​
items
object[]
required
​
total
integer
required
​
page
integer
required
​
rowsPerPage
integer
required
​
success
boolean
required
Example:

true