API Endpoint: Retrieve Credit Application
This endpoint allows you to retrieve information about credit applications. The request can specify which fields to return, enabling you to customize the response according to your needs.
Request
-
Method: GET
-
URL:
{{url}}/api/resource/Credit Application -
Query Parameters:
fields: A JSON array of strings that specifies the fields to include in the response. For example, you can request fields such asname,buyer_name, andstatus.
Example Request
GET {{url}}/api/resource/Credit Application?fields=["name", "buyer_name","status"]
Response
The response will be a JSON object containing an array of credit applications. Each application will include the fields specified in the request.
-
Response Structure:
-
data: An array of objects, where each object represents a credit application.-
name: The name associated with the credit application (string). -
buyer_name: The name of the buyer (string). -
status: The current status of the credit application (string).
-
-
Example Response
{
"data": [
{
"name": "",
"buyer_name": "",
"status": ""
}
]
}
This endpoint is useful for applications that need to display or process information about credit applications based on specific fields.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Request Query Parameters
- order_by (
string, optional)
Sort order for results; for example,creation descsorts by creation date descending (newest first). - limit_page_length (
integer, optional)
Number of records to return per page. Example:20returns 20 records. - limit_start (
integer, optional)
The starting index for records to support pagination. Example:20skips 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"
}
]
}