×
GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists?limit=<limit>&offset=<offset>

This API allows you get details of lists within an account. This API also allows you to search a particular list by list name and also sort the fetched response by name or date created.

It’s a bulk API which which works with offset & limit parameters to fetch specific set of data.

Parameter
Name
Value
Description
* offset
query

offset (optional)- This is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20

* name
query

name (optional)-Search on lists name 

* sort_by
query

sort_by (optional)- This indicates in what order the lists records are sorted in the API response. By default records are sorted by DateCreated in ascending order. However, you can override the same in following way for ascending order: Eg: date_created:asc or name:asc

Response Content Type
GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/lists?limit=<limit>&offset=<offset>

This API allows you get details of lists within an account. This API also allows you to search a particular list by list name and also sort the fetched response by name or date created.

It’s a bulk API which which works with offset & limit parameters to fetch specific set of data.

Parameter
Name
Value
Description
* offset
query

offset (optional)- This is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20

* name
query

name (optional)-Search on lists name 

* sort_by
query

sort_by (optional)- This indicates in what order the lists records are sorted in the API response. By default records are sorted by DateCreated in ascending order. However, you can override the same in following way for ascending order: Eg: date_created:asc or name:asc

Response Content Type
5
Share