API request and response objects related to one resource reference other objects through IDs.
As an example, the response from a GET method request to the /v5/platform/ endpoint returns the following example response object.
{
"meta": {
"query": {},
"total": 1
},
"data": [
{
"scope_id": null,
"name": "dotcom",
"color": "#2b2c30",
"avatar_id": null,
"type": "native:dotcom",
"id": "platform:594227513073503629",
"capabilities": [
"can_post"
],
"updated_at": "2015-06-28T18:07:59+00:00"
}
]
}
In this object the ID field contains a reference to a specific platform object with an ID value of platform:594227513073503629.
This value can be used in a call to the /platform/{platform_id} endpoint in order to retrieve the detailed information for a specific API with the following curl command.
curl "https://percolate.com/api/v5/platform/platform:594227513073503629" \
-X "GET" \
-H "Authorization: Bearer {your_access_token}" \
-H "Content-type: application/json; charset=utf-8"