# Returning.AI-dev ## Docs - [Getting Started](https://sgtr-dev.returning.ai/doc-2046835.md): - [Application API](https://sgtr-dev.returning.ai/folder-7435299.md): - [Integration API](https://sgtr-dev.returning.ai/folder-7435300.md): - [Channels](https://sgtr-dev.returning.ai/folder-7435294.md): - Channels [Iframe](https://sgtr-dev.returning.ai/doc-2046843.md): - [Events](https://sgtr-dev.returning.ai/folder-7435295.md): - Events [Outgoing webhooks](https://sgtr-dev.returning.ai/folder-7435337.md): - Events > Outgoing webhooks [Encryption](https://sgtr-dev.returning.ai/doc-2046846.md): - Events > Outgoing webhooks [User Joins Server](https://sgtr-dev.returning.ai/doc-2046847.md): - Events > Outgoing webhooks [User Visits server](https://sgtr-dev.returning.ai/doc-2046848.md): - Events > Outgoing webhooks [New Message Posted Anywhere](https://sgtr-dev.returning.ai/doc-2046849.md): - Events > Outgoing webhooks [New Message Posted To channel ](https://sgtr-dev.returning.ai/doc-2046850.md): - Events > Outgoing webhooks [Purchased Store Item ](https://sgtr-dev.returning.ai/doc-2046851.md): - Events [Incoming webhooks](https://sgtr-dev.returning.ai/folder-7435338.md): - Events > Incoming webhooks [API Keys & Encryption](https://sgtr-dev.returning.ai/doc-2046852.md): - Events > Incoming webhooks [Send message into channels](https://sgtr-dev.returning.ai/doc-2046853.md): - Events > Incoming webhooks [Update Custom User Fields](https://sgtr-dev.returning.ai/doc-2046854.md): - Events > Incoming webhooks [Update In-game currency](https://sgtr-dev.returning.ai/doc-2046855.md): - [Widgets](https://sgtr-dev.returning.ai/folder-7435296.md): - Widgets [Authenticated Widgets](https://sgtr-dev.returning.ai/doc-2046858.md): - Widgets [Public widgets](https://sgtr-dev.returning.ai/doc-2046859.md): ## API Docs - Authentication [Secure Auth](https://sgtr-dev.returning.ai/api-31437510.md): This endpoint authenticates a user and log them into the community. - Authentication [register](https://sgtr-dev.returning.ai/api-31437511.md): - Authentication [verify email](https://sgtr-dev.returning.ai/api-31437512.md): - Authentication [login](https://sgtr-dev.returning.ai/api-31437513.md): - Users [Get user](https://sgtr-dev.returning.ai/api-31437539.md): Retrieve user information by user ID with optional field selection. - Users [Get Users with Filters](https://sgtr-dev.returning.ai/api-31437568.md): This endpoint searches and retrieves platform users based on specified filter criteria, returning only the requested fields for each matching user. It provides flexible filtering capabilities with pagination support for large result sets. - Users [Create New User](https://sgtr-dev.returning.ai/api-31437569.md): This endpoints creates a new user in your community. - Users [Get User Data](https://sgtr-dev.returning.ai/api-31437570.md): This endpoints returns all user fields (Default and Custom) for a single user. - Users [Manage User Account](https://sgtr-dev.returning.ai/api-31437571.md): This endpoints allows you to delete or restore a user in your community. - Users [Get User Gamification Stats](https://sgtr-dev.returning.ai/api-31437572.md): This endpoint returns the past gamification stats history for a specific user, providing the count of how many times user completed the action daily over a specified time range. - Users [Get all mini game logs by user email](https://sgtr-dev.returning.ai/api-31437581.md): This endpoint returns Mini Game Logs with user email - Users [Get user's current Mini Games and Streak stats](https://sgtr-dev.returning.ai/api-31437582.md): API Endpoint to get user's current Mini Games and Streak stats - Roles & Permissions [role list of server](https://sgtr-dev.returning.ai/api-31437522.md): - Roles & Permissions [create new role](https://sgtr-dev.returning.ai/api-31437523.md): - Roles & Permissions [update role](https://sgtr-dev.returning.ai/api-31437524.md): - Roles & Permissions [delete role](https://sgtr-dev.returning.ai/api-31437525.md): - Roles & Permissions [get role list of user on a server](https://sgtr-dev.returning.ai/api-31437526.md): - Roles & Permissions [add role to a user on a server](https://sgtr-dev.returning.ai/api-31437527.md): - Roles & Permissions [remove role from a user on a server](https://sgtr-dev.returning.ai/api-31437528.md): - Servers [create new server](https://sgtr-dev.returning.ai/api-31437514.md): - Servers [get my servers](https://sgtr-dev.returning.ai/api-31437515.md): - Servers [update server](https://sgtr-dev.returning.ai/api-31437516.md): - Channels [channel list of server](https://sgtr-dev.returning.ai/api-31437517.md): - Channels [get channels list](https://sgtr-dev.returning.ai/api-31437518.md): - Channels [create new channel](https://sgtr-dev.returning.ai/api-31437519.md): - Channels [update channel](https://sgtr-dev.returning.ai/api-31437520.md): - Channels [delete channel](https://sgtr-dev.returning.ai/api-31437521.md): - Channels [Get Channels List](https://sgtr-dev.returning.ai/api-31437588.md): This endpoint gets the list of channels in the community. - Messaging [Get Messages](https://sgtr-dev.returning.ai/api-31437583.md): This endpoint returns the message history of users in the community. - Messaging [Send Message](https://sgtr-dev.returning.ai/api-31437584.md): This endpoint sends a message to a channel as a specified user. - Messaging [Reply Message](https://sgtr-dev.returning.ai/api-31437585.md): This endpoints sends a reply to a message as a specified user. - Messaging [React Message](https://sgtr-dev.returning.ai/api-31437586.md): This endpoints sends a reaction to a message as a specified user. - Messaging [Upload Image](https://sgtr-dev.returning.ai/api-31437587.md): This endpoint allows uploading images in buffer format and returns the file URL along with related information. - User Data [Get All User Fields](https://sgtr-dev.returning.ai/api-31437547.md): This endpoint retrieves all user fields associated with a specific community. - User Data [Get Specific User Field](https://sgtr-dev.returning.ai/api-31437548.md): This endpoint retrieve detailed information about a specific user field within a community by its field ID or field name. - User Data [Create Custom User Field](https://sgtr-dev.returning.ai/api-31437549.md): This endpoint creates a new custom field for a community. - User Data [Update Custom User Field](https://sgtr-dev.returning.ai/api-31437550.md): This endpoint updates an existing custom user field in a community. - User Data [Delete Custom User Field](https://sgtr-dev.returning.ai/api-31437551.md): This endpoint deletes an custom user field in a community. - User Data [Get all user field histories in a community](https://sgtr-dev.returning.ai/api-31437542.md): Retrieve all user field history records within a community with full user and field details. - User Data [Get user field histories for a specific field](https://sgtr-dev.returning.ai/api-31437543.md): Retrieve all user field history records for a specific field within a community. - User Data [Get user field histories for a specific user](https://sgtr-dev.returning.ai/api-31437544.md): Retrieve all user field history records for a specific user within a community. - User Data [Get user field histories of specific user field and user](https://sgtr-dev.returning.ai/api-31437545.md): Retrieve the history of changes for a specific user field and user within a community. - User Data [Create user field history for specific user](https://sgtr-dev.returning.ai/api-31437546.md): Creates a new history entry for a user field value change in a community. - Gamification [get badges list](https://sgtr-dev.returning.ai/api-31437529.md): - Gamification [create new badge](https://sgtr-dev.returning.ai/api-31437530.md): - Gamification [update badge](https://sgtr-dev.returning.ai/api-31437531.md): - Gamification [delete badge](https://sgtr-dev.returning.ai/api-31437532.md): - Gamification [remove badge from user](https://sgtr-dev.returning.ai/api-31437534.md): - Gamification [award badge to user](https://sgtr-dev.returning.ai/api-31437533.md): - Gamification [Get Tier Info](https://sgtr-dev.returning.ai/api-31437589.md): - Gamification [Get User Gamification History](https://sgtr-dev.returning.ai/api-31437590.md): This endpoint retrieves the past gamification history for a specific user, including the XP earned and in-game currency collected on a daily basis over a specified time range. - Gamification [Get User Gamification Logs](https://sgtr-dev.returning.ai/api-31437591.md): - Streaks & Mini Games [Get Streak Logs](https://sgtr-dev.returning.ai/api-31437611.md): - Rewards & Redemptions [Update redemption transaction status](https://sgtr-dev.returning.ai/api-31437605.md): Endpoint to update the status of an existing Redemption Order based on incoming payload data. - Rewards & Redemptions [ Get all redemption transactions by user email](https://sgtr-dev.returning.ai/api-31437606.md): Get all redemption transactions by user email with pagination - Rewards & Redemptions [Get All Redemption Statuses](https://sgtr-dev.returning.ai/api-31437607.md): Get all active redemption statuses for a community, grouped by category. - Rewards & Redemptions [Get Redemption Status by ID](https://sgtr-dev.returning.ai/api-31437608.md): Get a specific redemption status by its ID and community. - Rewards & Redemptions [ Get all redemption transactions by Community](https://sgtr-dev.returning.ai/api-31437610.md): Get all redemption transactions for community with pagination - Rewards & Redemptions [Create Redemption Status](https://sgtr-dev.returning.ai/api-31437609.md): Create a new redemption status for the community. The `order` is auto-calculated (max existing order + 1). - Chart Analysis [Create Analysis](https://sgtr-dev.returning.ai/api-31437562.md): Creates a new technical chart analysis with: - Chart Analysis [Get Analysis](https://sgtr-dev.returning.ai/api-31437563.md): Fetch a single analysis with full details including levels, drawings, and metadata. - Chart Analysis [Update Analysis](https://sgtr-dev.returning.ai/api-31437564.md): Update an existing analysis. Supports partial updates to: - Chart Analysis [Delete Analysis](https://sgtr-dev.returning.ai/api-31437565.md): Soft delete an analysis by marking the associated message as deleted. - Chart Analysis [List Analyses](https://sgtr-dev.returning.ai/api-31437566.md): List all analyses in a channel with pagination and filtering. - Chart Analysis [Append Drawings](https://sgtr-dev.returning.ai/api-31437567.md): Append additional drawings to an existing analysis without replacing existing drawings. - Bulk Operations [Bulk Import](https://sgtr-dev.returning.ai/api-31437573.md): This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file. - Bulk Operations [Get All Bulk Update](https://sgtr-dev.returning.ai/api-31437576.md): - Bulk Operations [Check Bulk Update Status](https://sgtr-dev.returning.ai/api-31437577.md): - Bulk Operations [Check Bulk Update Details](https://sgtr-dev.returning.ai/api-31437578.md): - Bulk Operations [Bulk Update](https://sgtr-dev.returning.ai/api-31437574.md): This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file. - Bulk Operations [Premium Currency Bulk Update](https://sgtr-dev.returning.ai/api-31437575.md): This endpoint allows updating multiple users' premium currency in a single request by providing the necessary data through a CSV file. - Application API > Community Users [Get community users](https://sgtr-dev.returning.ai/api-31437540.md): Retrieve a paginated list of users in a specific community with optional field selection. - Application API > Community Users [Get user](https://sgtr-dev.returning.ai/api-31437541.md): Retrieve user information by user ID within a community context with optional field selection. - Community Analytics [Get Loyalty Overview](https://sgtr-dev.returning.ai/api-32943555.md): Returns one record per active/engaged client with full loyalty metrics for a community.