API Documentation

Get Client Partners

The Get Client Partners API retrieves the list of partner clients associated with the authenticated client. This API is used to identify and fetch partner organisations configured within the QEval system.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetPartnerListByClientId
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 
[
    {
        "PartnerId": 101,
        "PartnerName": "QEval Partner One",
        "ParentId": 1,
        "CreatedDate": "2026-01-01T00:00:00",
        "IsActive": true,
        "ErrorCode": 0,
        "ResultCode": 0
    },
    {
        "PartnerId": 102,
        "PartnerName": "QEval Partner Two",
        "ParentId": 1,
        "CreatedDate": "2026-01-01T00:00:00",
        "IsActive": true,
        "ErrorCode": 0,
        "ResultCode": 0
    }
]

Status Codes

Code Status Description
200 Success Returns the list of partner clients successfully

Response Parameters

S.No Name Type Description
1 PartnerId Integer Unique identifier of the partner
2 PartnerName String Name of the partner client
3 ParentId Integer Identifier of the parent client
4 CreatedDate DateTime Partner creation date
5 IsActive Boolean Indicates whether the partner is active
6 ErrorCode Integer Error code returned by the API
7 ResultCode Integer Result status code

Failure 

</> JSON 
[
    {
        "Message": "The request is invalid"
    }
]

Status Codes

Code Status Description
401 Unauthorised Token missing, expired, or invalid
403 Forbidden Invalid or missing API key
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Unexpected server error occurred

Notes

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

    ×

    Contact Us