API Documentation

Get Client By Parent

The Get Client List by Parent API retrieves all child clients associated with the specified parent client. This API is useful for fetching client hierarchy details and obtaining the list of clients available under a parent account.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetClientListByParent
Method POST
Sub Domains “app” or “ai”

1. API Headers

Every API call must include two-factor authentication by providing the following headers:

Header Type Description
Authorisation String

Bearer <Generated_Token>  (generated after successful login)
X-API-KEY String   <Your_Unique_API_Key>  (generated after successful login)
  Note: If unavailable, email Qeval@etechtexas.com

2. Response Examples

Success

</> JSON 
[
    {
        "ClientId": 2,
        "ClientName": "QEval",
        "Domain": "Qevalpro.com",
        "ParentId": 1,
        "CreatedDate": "2026-01-01T00:00:00",
        "IsActive": true,
        "IsAccessIPBased": false,
        "IsDump": false,
        "DumpInsertSPName": null,
        "DumpDeleteSPName": null,
        "ClientLogo": null,
        "IsPartnerAllowed": false,
        "ProductLogo": null,
        "IsWhiteUrl": false,
        "WhiteUrl": null,
        "IsProductPartner": false,
        "ErrorCode": 0,
        "ResultCode": 0
    }
]

Status Codes

Code Status Description
200 Success Returns the list of client records successfully

Response Parameters

S.No Name Type Description
1 ClientId Integer Unique identifier of the client
2 ClientName String Name of the client
3 Domain String Domain associated with the client
4 ParentId Integer Parent client identifier
5 CreatedDate DateTime Client creation date
6 IsActive Boolean Indicates whether the client is active
7 IsAccessIPBased Boolean Indicates whether IP-based access is enabled
8 IsPartnerAllowed Boolean Indicates whether partner access is allowed
9 IsWhiteUrl Boolean Indicates whether white-label URL is configured
10 ErrorCode Integer Error code returned by the API
11 ResultCode Integer Result status code

Failure

</> JSON 
[
    {
        "Message": "Access denied. The provided token is invalid or not provided."
    }
]

Status Codes

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

Notes

  • Authentication is mandatory for accessing this API.
  • The API returns only the clients accessible to the authenticated user.
  • A successful response contains one or more client records along with configuration and status details.

    ×

    Contact Us