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
{
"id": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": {
"id": 1,
"name": "Retail Europe",
"suppress_id": 2,
"description": "Database description"
},
"error": 0,
"error_text": "Successful operation"
}
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 |