Get Platform by ID
This endpoint retrieves detailed information about a specific platform using its unique identifier.
Endpoint
GET /api/platform/:id
Authentication
No authentication required. This endpoint is publicly accessible.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The unique identifier of the platform to retrieve |
Response
Success Response
Code: 200 OK
Content Example:
{
"id": 90,
"name": "Tribe Social Members",
"slug": "tribe",
"description": "Training and Resources to turn you into a Tribe Social Expert!",
"upgradeBtn": null,
"heroImage": "1646920255868.png",
"favIconImage": null,
"heroBGColor": "#091235",
"heroTextColor": "#fff",
"primaryColor": "#307FE2",
"secondaryColor": "#307FE2",
"darkColor": "#091235",
"lightColor": null,
"heroImgOnly": false,
"fathomAnalytics": null,
"homepageUrl": "members.tribesocial.io",
"upgradeUrl": "tribesocial.io",
"logo": "1646920680134.svg",
"premiumToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYmFzaWMiLCJpYXQiOjE2NDY5MjAzMTF9.qXqr4ko0kx5IO8_bG9e4ntB_EYGBNbhMEYxOg_Yvs_4",
"basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoicHJlbWl1bSIsImlhdCI6MTY0NjkyMDMxMX0._V-55OaUsbnB2udeHBd3mf5NrKIk0XusqwV4Bu5pGsU",
"hideSignin": null,
"timezone": "(UTC-05:00) Eastern Time (US & Canada)",
"createdAt": "2022-03-10T13:51:51.000Z",
"updatedAt": "2022-03-10T13:58:03.000Z"
}
Error Response
Condition: If the platform with the specified ID does not exist.
Code: 404 Not Found
Content: "Not found"
Notes
- This endpoint returns the complete platform object with all its properties.
- The response includes branding information such as colors, images, and URLs.
- The platform tokens included in the response should be handled securely.
- This endpoint is useful for retrieving platform details for display or configuration purposes.
Example
curl -X GET "https://api.tribesocial.io/api/platform/90" \
-H "Content-Type: application/json"