Developer Docs

Table of contents

Get list by ID

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

Request URL:

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

Request parameters:

ParameterRequiredTypeDescription 
idYesintegerThe contact list ID that is generated by the BSG system when the list is created

Response parameters:

ParameterTypeDescription 
idintegerContact list ID
namestringContact list name
descriptionstringContact list description
defaultbooleanWhether the contact list is a default one: true or false value
created_atdatetimeDate and time when the contact list was created. Display format Y-m-d H:i:s

Response sample

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"
  }
}

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.