BSG utilizes HTTP cookies (and similar or complementary technologies) to 1) make this website safe, functional, and accessible (through the use of mandatory cookies) and 2) understand how you use our website (through the use of optional cookies) in order to improve your experience and to provide you with personalized content.

The information in the cookie text files may be related to your personal preferences or your device and is intended to make the site operate according to your expectations. The information contained in cookies does not usually identify your identity directly but is helpful in providing you with a more personalized user experience.

In accordance with the requirements of the General Data Protection Regulation (GDPR) privacy and security law that governs how the personal data of individuals in the EU may be processed and transferred, we provide you the possibility to prohibit the use of certain types of cookies when you use our website.

Read our Cookie Notice and the Privacy Policy for detailed information on how BGS collects and uses cookies. Please note that prohibiting the use of certain types of cookies may affect your interaction with the website and limit the accessibility of services we offer you. Choose the appropriate category below to learn more and to disable cookies.

Accept All cookies*

*Recommended for comfortable use of the site

Accept only necessary cookies

Accept only selected cookies

Necessary cookies

Social media

Analytics

Marketing

Get list by ID

The method allows to get information about the contact list by its identifier.

To get list by ID, make a request to this URL:

GET https://one-api.bsg.world/api/groups/{id}

Request parameters:

Parameter	Required	Type	Description
id	Yes	integer	The contact list ID that is generated by the BSG system when the list is created

Response parameters:

Parameter	Type	Description
id	integer	Contact list ID
name	string	Contact list name
description	string	Contact list description
default	boolean	Whether the contact list is a default one: true or false value
created_at	datetime	Date and time when the contact list was created. Display format Y-m-d H:i:s
items	string	The number of numbers in the contact list.
stop_list_count	string	The number of numbers that are in the stop list of SMS and Viber.

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",
    "items": 10,
    "stop_list_count": 0
  }
}