Skip to main content

Get database information

Description

Retrieves a database information.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
idint1YesDatabase ID
formatint"json"NoResponse 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

ParameterTypeDescription
errorintError code
error_textstringError text
idintDatabase ID
namestringDatabase name
suppress_idintAssociated suppression list ID
descriptionstringDatabase description