Clients.Get

Description

Retrieves clients of logged in user.

Request Parameters

APIKey = {string} (required)
The API key you are using to authenticate the access.
Command = {Clients.Get} (required)
API Command
ResponseFormat = {JSON | XML} (required)
Response format
JSONPCallBack = {bool}
Send this parameter for cross-domain. More info about JSONP can be found here: http: //en.wikipedia.org/wiki/JSON#JSONP
OrderField = {any client field} (required)
Order field
OrderTYPE = {ASC | DESC} (required)
Order type

Response Parameters

Success = {true | false}
States if there is an error or not
ErrorCode = {integer}
If there is an error, error's code
TotalClientCount = {mixed}
Total number of clietns user has
Clients = {mixed}
Returned clients

Error Codes

1
order by field missing
2
sort type is missing
99998
Authentication failure or session expired
99999
Not enough privileges
  • 0 Users Found This Useful
Was this answer helpful?

Related Articles

Client.Login

Description Verifies and logs in the client account Request Parameters Command =...

Client.PasswordRemind

Description Sends the password reset email. Request Parameters Command =...

Client.PasswordReset

Description Resets clients password and sends the new password with email. Request Parameters...

Client.Create

Description Create new client account Request Parameters APIKey = {string} (required) The API...

Client.Update

Description Update client account information Request Parameters APIKey = {string}...