Skip to main content

Get resource information

Description

Retrieves detailed information about a single resource, including channels and associated databases.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format.
By default – json
idint1YesResource ID

Request example

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

Response example

{
"data": {
"channels": [
"email",
"push"
],
"dbs_ids": [
1
],
"id": 1,
"name": "Resource",
"trk_domain": "tracking.example.com",
"url": "https://blog.example:8080"
},
"error": 0,
"error_text": "Successful operation"
}

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
channelJSON arrayEnabled channels
dbs_idsJSON arrayAssociated databases
idintResource ID
namestringResource name
trk_domainstringSubscribers actions tracking domain
urlstringResource URL