Get database information

Description

Retrieves a database information.

Request URL

Method: POST

https://example.com/api/v1.1/databases/get/

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
id	int	1	Yes	Database ID
format	int	"json"	No	Response data format By default – json

Request example

JSON

{
  "id": 1,
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <id>1</id>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

Response example

JSON

{
  "data": {
    "id": 1,
    "name": "B2C customers",
    "suppress_id": 1,
    "description": "May contain info"
  },
  "error": 0,
  "error_text": "Successful operation"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <id>1</id>
    <name>B2C customers</name>
    <suppress_id>1</suppress_id>
    <description>May contain info</description>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Database ID
name	string	Database name
suppress_id	int	Associated suppression list ID
description	string	Database description