How to fetch your data to build your internal data warehouse

This guide explains how to use the new utilities data endpoints available at Adjutor API v2. These endpoints allow you to query multiple datasets (users, loans, wallets, transactions, and more) with built-in support for filtering, sorting, and pagination.

1. Base URL

All requests use the following base URL:

https://adjutor.lendsqr.com/v2

2. Overview of the API Structure

The new system introduces two key capabilities:

A. Options Endpoint (Dataset Discovery)

Before querying any data, you can retrieve all available datasets using:

GET /data/options

Example:

https://adjutor.lendsqr.com/v2/data/options

This returns a list of all supported datasets you can query.

B. Data Endpoint

To fetch actual data, use:

GET /data/<dataset-path>

Example:

https://adjutor.lendsqr.com/v2/data/users

3. Supported Features

Each dataset supports:

Filtering

Retrieve only records that match specific conditions.

Example:

/data/users?age=30

Sorting

Sort results by allowed fields.

Example:

/data/loans?sort=created_on

Pagination

Control result size and page navigation.

Common parameters:

  • limit → number of records per page
  • page → page number

Example:

/data/users?limit=50&page=2

4. Available Datasets

Below is a breakdown of all supported datasets, including their paths and supported filters.

Customers

  • Path: /users
  • Primary ID: id
  • Sort Columns: created_on, bvn
  • Filter Columns: created_on, age, phone_number, modified_on

Example:

/data/users?age=25&limit=20

Customer Loans

  • Path: /loans
  • Primary ID: id
  • Sort Columns: user_id, created_on
  • Filter Columns: id, user_id, approved_on, status

Example:

/data/loans?status=approved

Loan Transactions

  • Path: /loans/transactions
  • Primary ID: loan_id
  • Sort Columns: user_id, created_on
  • Filter Columns: loan_id, user_id, product_id

Loan Schedules

  • Path: /loans/schedules
  • Primary ID: id
  • Sort Columns: user_id, created_on
  • Filter Columns: loan_id, user_id

Transactions

  • Path: /transactions
  • Primary ID: id
  • Sort Columns: user_id, created_on
  • Filter Columns: user_id

Cards

  • Path: /cards
  • Primary ID: id
  • Filter Columns: org_id, user_id, card_type

Bank Accounts

  • Path: /bank-accounts
  • Primary ID: id
  • Filter Columns: org_id, user_id, created_on, account_number, bank_code, modified_on

Disbursement Transactions

  • Path: /disbursements/transactions
  • Primary ID: org_id
  • Sort Columns: transaction_date
  • Filter Columns: org_id, transaction_date

Disbursement Accounts

  • Path: /disbursements/accounts
  • Primary ID: org_id
  • Sort Columns: created_on
  • Filter Columns: org_id

Direct Debits

  • Path: /direct-debit-mandates
  • Primary ID: org_id
  • Sort Columns: created_on
  • Filter Columns: org_id

Customer Documents

  • Path: /documents
  • Primary ID: org_id
  • Sort Columns: created_on
  • Filter Columns: org_id

Wallets

  • Path: /wallets
  • Primary ID: id
  • Sort Columns: created_on
  • Filter Columns: created_on, account_balance, modified_on

Example:

/data/wallets?account_balance=10000

5. Example Use Cases

Get all users created recently

/data/users?sort=created_on&limit=10

Fetch approved loans for a user

/data/loans?user_id=123&status=approved

Get wallet records sorted by balance activity

/data/wallets?sort=modified_on

6. API Reference

Full technical reference is available here:
https://api.adjutor.io/#96aaaa83-6837-4be1-a9cb-6f1c0cd44f0e

See also

Was this page helpful?

On this page