×
GET

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

This API allows you to fetch details of bulk contacts of an account.

It supports limit and offset based pagination. Maximum records per page is 20.

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 by Campaign name 

* sort_by
query

sort_by (optional) This indicates in what order the campaign 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

* list_sids
query

list_sids(optional)-fetch the details of contacts belonging to a particular list

* filter
query

filter(optional) -If filter is “show_list” Response will contain associated list data too in contacts.

Response Content Type
GET

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

This API allows you to fetch details of bulk contacts of an account.

It supports limit and offset based pagination. Maximum records per page is 20.

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 by Campaign name 

* sort_by
query

sort_by (optional) This indicates in what order the campaign 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

* list_sids
query

list_sids(optional)-fetch the details of contacts belonging to a particular list

* filter
query

filter(optional) -If filter is “show_list” Response will contain associated list data too in contacts.

Response Content Type
5
Share