1. Home
  2. Client
  3. Client / GetList

Client / GetList

Method to get a list of clients.

Resource URL

https://api.wbsrvc.com/Client/GetList/

Method

POST

Parameters

user_key
Required
User Key of the user who initiates the call.
Type: string
client_id
Optional
ID of the client.
Type: integer
status
Optional
Filter using the client status.
Type: string – possible value ‘all’, ‘pending’, ‘trial’, ‘active’, ‘suspended_all’
company_name
Optional
Filter using the client name.
Type: string
sort_by
Optional
Sort resulting clients.
Type: string – possible value ‘company_name’, ‘registered_date’, ‘mailing_limit’, ‘month_limit’, ‘contact_limit’, ‘last_activity’
direction
Optional
Direction of the sorting.
Type: string – possible value ‘asc’, ‘desc’
limit
Optional
Limit the number of resulting clients.
Type: integer
offset
Optional
Offset the beginning of resulting clients.
Type: integer
count
Optional
Return the number of clients.
Type: string – possible value ‘true’, ‘false’
recursive
Optional
Return all sub accounts recursively.
Type: string – possible value ‘true’, ‘false’
Updated on November 15, 2017

Was this article helpful?

Related Articles