Skip to main content

Get resources list

Description

Retrieves all created resources list.

Request URL

Method: POST

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

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
By default – json
from_idint1NoThe first ID in the response.
By default – 1
limitint1NoResources list limit.
By default – 1000
groups[]String[ "group1", "group2" ]NoList of access groups
groups_id[]int[ 0, 1 ]NoList of access groups IDs

Request example

{
"from_id": 1,
"limit": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
"data": [
{
"id": 1,
"name": "Resource"
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 3
"total_count": 1
}

Response parameters

ParameterTypedescription
errorintError code
error_textstringError text
next_from_idintThe index must be passed in the next request to receive another piece of data, until the result output contains 0 history lines
idintResource ID
namestringResource name
total_countintTotal resources count
groups[]StringList of groups