List of applications
This endpoint retrieves a list of applications, providing key details such as the application ID, creation date, status, and DBA (Doing Business As) name of the applicant.
Request
Endpoint
| environment | HTTP method | endpoint |
|---|---|---|
| Sandbox testing | GET | https://api-sandbox.flex-charge.com/v1/onboarding/application/list |
| Production environment | GET | https://api.flex-charge.com/v1/onboarding/application/list |
Required Key
bearer token | The auth token returned by /oauth2/token |
Query Parameters (Optional)
| Parameter | Type | Description |
|---|---|---|
status | String | Filter applications by status (e.g., DRAFT, SUBMITTED, IN_REVIEW, APPROVED, DECLINED). |
createdFrom | Date | Retrieve applications created on or after this date (ISO 8601 format). |
createdTo | Date | Retrieve applications created on or before this date (ISO 8601 format). |
sortBy | String | Sort results by a field (createdOn, status, dba). |
sortOrder | String | Sort order, either asc for ascending or desc for descending. |
pageSize | Integer | Number of results per page (default: 10). |
pageNumber | Integer | The page number to retrieve for paginated results. |
Response
Field Definitions
| Field Name | Type | Description |
|---|---|---|
id | String | The unique identifier of the application. |
createdOn | String | The date and time when the application was created (in ISO 8601 format). |
status | String | The current status of the application (DRAFT, SUBMITTED, etc.). |
dba | String | The Doing Business As name associated with the application. |
totalItemCount | Integer | Total number of items available across all pages. |
pageNumber | Integer | The current page number of the result set. |
pageSize | Integer | The number of items per page. |
rows | Array | Array containing the list of applications. Each entry includes the fields below. |
- id | String | The unique identifier of the application. |
- createdOn | String | The creation date of the application. |
- status | String | The status of the application. |
- dba | String | The Doing Business As name for the applicant. |
Notes
- Pagination is applied to the results. Use
pageSizeandpageNumberto navigate through the results.- Filtering by status or date is optional but recommended for large datasets.
Payload Examples
Request
cURL Request Example
curl --request GET \
--url "https://api-sandbox.flex-charge.com/v1/application/list?status=SUBMITTED&pageSize=5&pageNumber=1" \
--header 'Authorization: bearer {the token returned by /oauth2}' \
--header 'accept: application/json'
Response
JSON Example for Paginated List
{
"totalItemCount": 25,
"pageNumber": 1,
"pageSize": 5,
"rows": [
{
"id": "application_123456",
"createdOn": "2024-11-01T10:30:00Z",
"status": "SUBMITTED",
"dba": "Tech Innovators"
},
{
"id": "application_654321",
"createdOn": "2024-11-02T12:45:00Z",
"status": "DRAFT",
"dba": "Example Corp"
},
{
"id": "application_789012",
"createdOn": "2024-11-03T14:20:00Z",
"status": "IN_REVIEW",
"dba": "Sample Business"
},
{
"id": "application_345678",
"createdOn": "2024-11-04T16:10:00Z",
"status": "APPROVED",
"dba": "Digital Edge"
},
{
"id": "application_901234",
"createdOn": "2024-11-05T18:55:00Z",
"status": "DECLINED",
"dba": "Startup Solutions"
}
]
}
Example for No Results
{
"totalItemCount": 0,
"pageNumber": 1,
"pageSize": 5,
"rows": []
}
Notes
- Use filters (e.g.,
status,createdFrom,createdTo) to narrow down results and optimize performance.- Ensure you implement pagination correctly to handle large datasets efficiently.
Updated 1 day ago