Developer Docs

Table of contents

Get list

Provides an index of all the contact lists with data.

To get list, make a request to this URL:


Request parameters:

page[limit]NointegerThe number of groups in the response. The value range for the parameter: min – 15, max – 500.
The default is 30.
page[offset]NointegerGet groups starting from offset. The default is 0.

Response parameters:

idintegerThe unique identifier of the contact list automatically generated by the BSG system when creating the contact list.
namestringContact list name.
descriptionstringContact list description.
defaultbooleanIf the contact list is a default one. Possible values: true or false.
created_atdatetimeDate and time when the contact list was created. Display format ― Y-m-d H:i:s
totalintegerTotal number of the existing contact lists.

If request is successful, you will receive a response:

  "data": [
      "id": 1,
      "name": "string",
      "description": "string",
      "default": 0,
      "created_at": "2022-04-28 14:21:16"
  "total": 1

We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you’re agreeing to the collection of data as described in our Website Data Collection Policy.