GET Client List

Get the onboard client list under different groups.

URL : /api/v1/clients-list/

Method : GET

Auth required : YES

Parameters

Parameter	Type	Description
page_no	integer	The page number of the results to return. Default is 1
page_limit	integer	The maximum number of results to return per page. Default is 10
client_email	string	The name of the client group to filter the results by. (Optional)
request_status	string	The status of the client request. Possible values: `pending`, `declined`, `completed`, `accepted`, `requested`. (Optional )
client_type	string	The type of the client. Possible values: `individual`, `company`. (Optional)
group_name	string	The name of the client group to filter the results by. (Optional)

Response

The response will contain a JSON object with the following fields:

Field	Type	Description
`page_number`	int	The current page number.
`total_count`	int	The total number of results available.
`page_limit`	int	The maximum number of results returned per page.
`total_pages`	int	The total number of pages.
`results`	array	An array of objects representing the search results.

Each object in the results array will have the following fields:

Field	Type	Description
`reference_id`	string	The unique reference ID of client.
`email`	string	The email address of the client.
`client_name`	string	The name of the client.
`client_type`	string	The type of the client.
`group_name`	string	The name of the group that the client was onboarded into.
`group_token`	string	The unique group token.
`request status`	string	The status of the client request.
`client_status`	string	The active status of the client.
`created_at`	string	Client creation time.

Here's an example response:

Code : 200 OK

👾

**Success Response.

Content examples

Request

/api/v1/clients-list/?page=2&page_limit=10

Response

{
    "status_code": 200,
    "message": "Success",
    "data": {
        "page_number": 1,
        "total_count": 2,
        "page_limit": 10,
        "total_pages": 1,
        "results": [
          
            {
                "reference_id": "1687353539134-2556",
                "email": "crannematriddo-4028@yopmail.com",
                "client_name": "David Lahm",
                "client_type": "individual",
                "group_name": "Test",
                "group_token": "9ea8a3ed-ad4d-4e54-888e-fdc4daa03d8c",
                "request_status": "Completed",
                "client_status": "active",
                "created_at": "2023-06-21T13:18:59.136559Z"
            },
            
            {
                "reference_id": "1681718341078-1408",
                "email": "inditest@gmail.com",
                "client_name": "Ariel Herring",
                "client_type": "individual",
                "group_name": "Test 1",
                "group_token": "08c05d67-b5ed-455c-9134-1d6dc24392d4",
                "request_status": "Completed",
                "client_status": "active",
                "created_at": "2023-04-17T07:59:01.079570Z"
            }
        ]
    }
}

Clients Individual Client Overview