Get Platform by Slug

This endpoint retrieves detailed platform information using its unique slug identifier.

Endpoint

GET /api/platform/slug/:slug

Authentication

Authentication is optional. Authenticated requests may receive additional information based on user permissions.

Parameters

Path Parameters

Parameter	Type	Required	Description
slug	string	Yes	The unique slug identifier of the platform (e.g., "inovo")

Response

Success Response

Code: 200 OK

Content Example:

{
  "id": 8,
  "name": "Tech Advice for Founders - Inovo",
  "slug": "inovo",
  "description": "",
  "upgradeBtn": null,
  "heroImage": "1645754926775.png",
  "favIconImage": null,
  "heroBGColor": "#091235",
  "heroTextColor": "#fff",
  "primaryColor": "#FF524B",
  "secondaryColor": null,
  "darkColor": "#091235",
  "lightColor": null,
  "heroImgOnly": true,
  "fathomAnalytics": null,
  "homepageUrl": "members.inovo.io",
  "upgradeUrl": "",
  "logo": "1645722042710.png",
  "premiumToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoicHJlbWl1bSIsImlhdCI6MTY0NTc1MTIyM30.4CxMU6EN6vlYCwkI2gfjsPTeqVfkE6BEgRgOko8xSqk",
  "basicToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYmFzaWMiLCJpYXQiOjE2NDU3NTEyMjN9.ouAYseNMqwIO4wEFo5Es5c6mMNZVihgKKuXN8oGH2uM",
  "hideSignin": null,
  "timezone": "US/Eastern",
  "createdAt": "2020-10-01T12:25:11.000Z",
  "updatedAt": "2022-02-25T14:30:49.000Z",
  "Links": [
    {
      "id": 1,
      "title": "Google",
      "url": "https://google.com",
      "position": 1,
      "createdAt": "2020-10-03T19:27:28.000Z",
      "updatedAt": "2020-10-04T22:37:34.000Z",
      "PlatformId": 8
    },
    {
      "id": 3,
      "title": "Facebook",
      "url": "https://facebook.com",
      "position": 2,
      "createdAt": "2020-10-03T19:32:41.000Z",
      "updatedAt": "2020-10-04T22:37:21.000Z",
      "PlatformId": 8
    }
  ],
  "tags": [
    {
      "id": 256,
      "title": "GoDaddy"
    },
    {
      "id": 257,
      "title": "Domain Name"
    }
  ]
}

Error Response

Condition: If the platform with the specified slug does not exist or another error occurs.

Code: 400 Bad Request

Content: {error}

Notes

• This endpoint returns the complete platform object with all its properties.
• The response includes related data such as platform links and tags.
• The platform tokens included in the response should be handled securely.
• This is one of the most commonly used endpoints for retrieving platform information, as slugs are often used in URLs and are human-readable.

Example

curl -X GET "https://api.tribesocial.io/api/platform/slug/inovo" \
  -H "Content-Type: application/json"