Get Credit Application List

This API retrieves a paginated list of Credit Applications, including their name, buyer’s name, and status. Results can be ordered, paged, and filtered according to query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Query Parameters

  • order_by (string, optional)
    Sort order for results; for example, creation desc sorts by creation date descending (newest first).
  • limit_page_length (integer, optional)
    Number of records to return per page. Example: 20 returns 20 records.
  • limit_start (integer, optional)
    The starting index for records to support pagination. Example: 20 skips the first 20 records.
  • fields (array, optional)
    List of fields to include in the response for each credit application. Example: ["name", "buyer_name", "status"].
  • or_filters (string, optional)
    (Typically) a JSON string specifying alternative filters; empty by default.

Response Explanation

The response contains a data array listing the credit applications.


Response Body Fields

Each object inside the data array contains:

  • name (string)
    Unique identifier of the credit application.

  • buyer_name (string)
    Name of the buyer associated with the application.

  • status (string)
    Status of the credit application (e.g., Working, Approved, Rejected, New).


Example Response

{
  "data": [
    {
      "name": "C-2024-03-00001",
      "buyer_name": "Mr Austin Gilbert",
      "status": "Working"
    },
    ...
    {
      "name": "C-2024-04-00008",
      "buyer_name": "Aditya Lolge",
      "status": "New"
    }
  ]
}
Query Params
fields
array of strings
required
Defaults to ["name", "buyer_name","status"]

Fields that you want to fetch. "name" is the primary key or ID of the document

fields*
filters
array of strings
Defaults to [["status","=","Approved"]]

Array of filter conditions to apply

filters
number
Defaults to 20

Number of records per page (default: 20)

number
Defaults to 0

Starting index for pagination (default: 0)

string
Defaults to modified desc

Field to sort by (e.g., "modified desc", "name asc")

Headers
string
required
Defaults to <Token>
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json