Skip to main content

Get Platform Info

This endpoint retrieves comprehensive information about a platform, including associated content, creators, and configuration data. It's primarily designed for mobile app use.

caution

This is an internal endpoint primarily intended for mobile app integration. It returns a large amount of data in a single request and may not be suitable for all use cases.

Endpoint

GET /api/platform/info

Authentication

No authentication required. This endpoint is publicly accessible.

Parameters

Query Parameters

ParameterTypeRequiredDescription
platformIdstringYesThe unique identifier of the platform to retrieve information for

Response

Success Response

Code: 200 OK

Content Example:

{
"followingCreatorsContent": [...],
"featuredChurches": [...],
"featuredContent": null,
"trendingContent": [...],
"topics": [...],
"ads": [...],
"platformdata": {...}
}

The response includes several key sections:

  • followingCreatorsContent: Content from creators the user is following
  • featuredChurches: Featured groups or organizations on the platform
  • featuredContent: Highlighted content (if available)
  • trendingContent: Popular content on the platform
  • topics: Available topics or categories
  • ads: Advertisements configured for the platform
  • platformdata: Complete platform configuration and settings

Error Response

No specific error responses are documented for this endpoint. Standard HTTP error codes may apply.

Notes

  • This endpoint aggregates multiple data sources into a single response.
  • It's optimized for mobile applications that need to load comprehensive platform data.
  • The response size can be large due to the inclusion of content and configuration data.
  • Consider using more specific endpoints for targeted data retrieval in web applications.

Example

curl -X GET "https://api.tribesocial.io/api/platform/info?platformId=36" \
-H "Content-Type: application/json"