API DocumentationList: GetList
Method to get a list of lists.
Resource URL
https://api.wbsrvc.com/List/GetList/
Method
POST
Parameters
| user_key Required |
User Key of the user who initiates the call. Type: string |
| status Optional |
Filter using the list status. Type: string - possible value 'active', 'archived' |
| name Optional |
Filter using the list name. Type: string |
| sort_by Optional |
Sort resulting lists. Type: string - possible value 'name', 'created_on', 'active_members_count' |
| direction Optional |
Direction of the sorting. Type: string - possible value 'asc', 'desc' |
| limit Optional |
Limit the number of resulting lists. Type: integer |
| offset Optional |
Offset the beginning of resulting lists. Type: integer |
| count Optional |
Return the number of lists. Type: string - possible value 'true', 'false' |
| no_details Optional |
Do not retrieve all the stats for the list. Type: string - possible value 'true', 'false' |
| with_engagement Optional |
Calculate the engagement for the list. Type: string - possible value 'true', 'false' |
| client_id Optional |
Client ID of the client in which the list is located. Type: integer |