# Returning.AI ## Docs - [Returning.AI](https://dev.returning.ai/home.md): - Returning.AI [APIs](https://dev.returning.ai/apis.md): - Returning.AI > APIs [Authentication](https://dev.returning.ai/apis/authentication.md): - Returning.AI > APIs [System API](https://dev.returning.ai/apis/system.md): - Returning.AI > APIs [Application API](https://dev.returning.ai/apis/application.md): - Returning.AI > APIs > Application API [User Fields](https://dev.returning.ai/user-fields.md): - Returning.AI > APIs [Integration API](https://dev.returning.ai/apis/integration.md): - Returning.AI [Channels](https://dev.returning.ai/channels.md): - Returning.AI > Channels [Iframe](https://dev.returning.ai/channels-iframe.md): - Returning.AI [Events](https://dev.returning.ai/events.md): - Returning.AI > Events [Outgoing webhooks](https://dev.returning.ai/outgoing-webhooks.md): - Returning.AI > Events > Outgoing webhooks [Encryption](https://dev.returning.ai/outgoing-webhook-encryption.md): - Returning.AI > Events > Outgoing webhooks [User Joins Server](https://dev.returning.ai/outgoing-webhook-user-join-server.md): - Returning.AI > Events > Outgoing webhooks [User Visits server](https://dev.returning.ai/outgoing-webhook-user-visit-server.md): - Returning.AI > Events > Outgoing webhooks [New Message Posted Anywhere](https://dev.returning.ai/outgoing-webhooke-new-message-posted-anywhere.md): - Returning.AI > Events > Outgoing webhooks [New Message Posted To channel ](https://dev.returning.ai/outgoing-webhooke-new-message-posted-to-specific-channel.md): - Returning.AI > Events > Outgoing webhooks [Purchased Store Item ](https://dev.returning.ai/outgoing-webhooke-purchase-store-item.md): - Returning.AI > Events [Incoming webhooks](https://dev.returning.ai/incoming-webhooks.md): - Returning.AI > Events > Incoming webhooks [API Keys & Encryption](https://dev.returning.ai/incoming-webhook-api-key-and-encryption.md): - Returning.AI > Events > Incoming webhooks [Send message into channels](https://dev.returning.ai/incoming-webhook-send-messages.md): - Returning.AI > Events > Incoming webhooks [Update Custom User Fields](https://dev.returning.ai/incoming-webhook-update-custom-fields.md): - Returning.AI > Events > Incoming webhooks [Update In-game currency](https://dev.returning.ai/incoming-webhook-update-in-game-currency.md): - Returning.AI [Widgets](https://dev.returning.ai/widgets.md): - Returning.AI > Widgets [Authenticated Widgets](https://dev.returning.ai/widgets/authenticated.md): - Returning.AI > Widgets [Public widgets](https://dev.returning.ai/widgets/public.md): ## API Docs - Returning.AI > APIs > System API > Auth [Secure Auth](https://dev.returning.ai/apis/system/secure-auth.md): This endpoint authenticates a user and log them into the community. - Returning.AI > APIs > System API > Auth [register](https://dev.returning.ai/apis/system/register.md): - Returning.AI > APIs > System API > Auth [verify email](https://dev.returning.ai/apis/system/verify-email.md): - Returning.AI > APIs > System API > Auth [login](https://dev.returning.ai/apis/system/login.md): - Returning.AI > APIs > System API > Server [create new server](https://dev.returning.ai/apis/system/create-new-server.md): - Returning.AI > APIs > System API > Server [get my servers](https://dev.returning.ai/apis/system/get-my-server.md): - Returning.AI > APIs > System API > Server [update server](https://dev.returning.ai/apis/system/update-server.md): - Returning.AI > APIs > System API > Server [channel list of server](https://dev.returning.ai/apis/system/channel-list.md): - Returning.AI > APIs > System API > Channel [get channels list](https://dev.returning.ai/apis/system/get-channels-list.md): - Returning.AI > APIs > System API > Channel [create new channel](https://dev.returning.ai/apis/system/create-new-channel.md): - Returning.AI > APIs > System API > Channel [update channel](https://dev.returning.ai/apis/system/update-channel.md): - Returning.AI > APIs > System API > Channel [delete channel](https://dev.returning.ai/apis/system/delete-channel.md): - Returning.AI > APIs > System API > Role [role list of server](https://dev.returning.ai/apis/system/role-list.md): - Returning.AI > APIs > System API > Role [create new role](https://dev.returning.ai/apis/system/create-new-role.md): - Returning.AI > APIs > System API > Role [update role](https://dev.returning.ai/apis/system/update-role.md): - Returning.AI > APIs > System API > Role [delete role](https://dev.returning.ai/apis/system/delete-role.md): - Returning.AI > APIs > System API > Role [get role list of user on a server](https://dev.returning.ai/apis/system/get-role-list-of-user.md): - Returning.AI > APIs > System API > Role [add role to a user on a server](https://dev.returning.ai/apis/system/add-role-to-user.md): - Returning.AI > APIs > System API > Role [remove role from a user on a server](https://dev.returning.ai/apis/system/remove-role-from-user.md): - Returning.AI > APIs > System API > Badge [get badges list](https://dev.returning.ai/apis/system/get-badge-list.md): - Returning.AI > APIs > System API > Badge [create new badge](https://dev.returning.ai/apis/system/create-new-badge.md): - Returning.AI > APIs > System API > Badge [update badge](https://dev.returning.ai/apis/system/update-badge.md): - Returning.AI > APIs > System API > Badge [delete badge](https://dev.returning.ai/apis/system/delete-badge.md): - Returning.AI > APIs > System API > Badge [award badge to user](https://dev.returning.ai/apis/system/award-badge-to-user.md): - Returning.AI > APIs > System API > Badge [remove badge from user](https://dev.returning.ai/apis/system/remove-badge-from-user.md): - Returning.AI > APIs > Application API > Community Users [Get community users](https://dev.returning.ai/apis/application/get-community-users.md): Retrieve a paginated list of users in a specific community with optional field selection. - Returning.AI > APIs > Application API > Community Users [Get user](https://dev.returning.ai/apis/application/get-user.md): Retrieve user information by user ID within a community context with optional field selection. - Returning.AI > APIs > Application API > User Fields [Get All User Fields](https://dev.returning.ai/apis/application/get-all-user-fields.md): This endpoint retrieves all user fields associated with a specific community. - Returning.AI > APIs > Application API > User Fields [Get Specific User Field](https://dev.returning.ai/apis/application/get-specific-user-field.md): This endpoint retrieve detailed information about a specific user field within a community by its field ID or field name. - Returning.AI > APIs > Application API > User Fields [Create Custom User Field](https://dev.returning.ai/apis/application/create-custom-user-field.md): This endpoint creates a new custom field for a community. - Returning.AI > APIs > Application API > User Fields [Update Custom User Field](https://dev.returning.ai/apis/application/update-custom-user-field.md): This endpoint updates an existing custom user field in a community. - Returning.AI > APIs > Application API > User Fields [Delete Custom User Field](https://dev.returning.ai/apis/application/delete-custom-user-field.md): This endpoint deletes an custom user field in a community. - Returning.AI > APIs > Application API > User Field Histories [Get all user field histories in a community](https://dev.returning.ai/apis/application/get-all-user-field-histories.md): Retrieve all user field history records within a community with full user and field details. - Returning.AI > APIs > Application API > User Field Histories [Get user field histories for a specific field](https://dev.returning.ai/apis/application/get-user-field-history.md): Retrieve all user field history records for a specific field within a community. - Returning.AI > APIs > Application API > User Field Histories [Get user field histories for a specific user](https://dev.returning.ai/apis/application/get-user-field-history-for-user.md): Retrieve all user field history records for a specific user within a community. - Returning.AI > APIs > Application API > User Field Histories [Get user field histories of specific user field and user](https://dev.returning.ai/apis/application/get-user-field-histories-of-specific-user-field-and-user.md): Retrieve the history of changes for a specific user field and user within a community. - Returning.AI > APIs > Application API > User Field Histories [Create user field history for specific user](https://dev.returning.ai/apis/application/create-user-field-history-for-user.md): Creates a new history entry for a user field value change in a community. - Returning.AI > APIs > Integration API > Users [Get Users with Filters](https://dev.returning.ai/apis/integration/get-users-with-filter.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. - Returning.AI > APIs > Integration API > Users [Create New User](https://dev.returning.ai/apis/integration/create-new-user.md): This endpoints creates a new user in your community. - Returning.AI > APIs > Integration API > Users [Get User Data](https://dev.returning.ai/apis/integration/get-user-data.md): This endpoints returns all user fields (Default and Custom) for a single user. - Returning.AI > APIs > Integration API > Users [Manage User Account](https://dev.returning.ai/apis/integration/manager-user-account.md): This endpoints allows you to delete or restore a user in your community. - Returning.AI > APIs > Integration API > Users [Get User Gamification History](https://dev.returning.ai/apis/integration/get-user-gamification-history.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. - Returning.AI > APIs > Integration API > Users [Get User Gamification Stats](https://dev.returning.ai/apis/integration/get-user-gamification-stats.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. - Returning.AI > APIs > Integration API > Users [Bulk Import](https://dev.returning.ai/apis/integration/bulk-import.md): This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file. - Returning.AI > APIs > Integration API > Users [Bulk Update](https://dev.returning.ai/apis/integration/bulk-update.md): This endpoint allows updating multiple user records in a single request by providing the necessary data through a CSV file. - Returning.AI > APIs > Integration API > Users [Get All Bulk Update](https://dev.returning.ai/api-23232174.md): - Returning.AI > APIs > Integration API > Users [Check Bulk Update Status](https://dev.returning.ai/api-23255232.md): - Returning.AI > APIs > Integration API > Users [Check Bulk Update Details](https://dev.returning.ai/api-23257539.md): - Returning.AI > APIs > Integration API > Messages [Get Messages](https://dev.returning.ai/get-messages.md): This endpoint returns the message history of users in the community. - Returning.AI > APIs > Integration API > Messages [Send Message](https://dev.returning.ai/apis/integration/send-message.md): This endpoint sends a message to a channel as a specified user. - Returning.AI > APIs > Integration API > Messages [Reply Message](https://dev.returning.ai/apis/integration/reply-message.md): This endpoints sends a reply to a message as a specified user. - Returning.AI > APIs > Integration API > Messages [React Message](https://dev.returning.ai/apis/integration/react-message.md): This endpoints sends a reaction to a message as a specified user. - Returning.AI > APIs > Integration API > Channels [Get Channels List](https://dev.returning.ai/apis/integration/get-channel-list.md): This endpoint gets the list of channels in the community. - Returning.AI > APIs > Integration API > Xp Settings [Get Tier Info](https://dev.returning.ai/api-22649493.md): ## Schemas - Sample Schemas [Pet](https://dev.returning.ai/schema-2616153.md): - Sample Schemas [Category](https://dev.returning.ai/schema-2616154.md): - Sample Schemas [Tag](https://dev.returning.ai/schema-2616155.md): - Schemas [ValidationError](https://dev.returning.ai/schema-7571119.md): - Schemas [NotFoundError](https://dev.returning.ai/schema-7571120.md): - Schemas [InternalServerError](https://dev.returning.ai/schema-7571121.md): - Schemas [NotImplementedError](https://dev.returning.ai/schema-7571122.md): - Schemas [CreateUserFieldHistoryResponse](https://dev.returning.ai/schema-7571123.md): - Schemas [CreateUserFieldHistorySuccessResponse](https://dev.returning.ai/schema-7571124.md): - Schemas [UserFieldHistoryItem](https://dev.returning.ai/schema-7571125.md): - Schemas [GetUserFieldHistoriesResponse](https://dev.returning.ai/schema-7571126.md): - Schemas [UserFieldHistoriesValidationError](https://dev.returning.ai/schema-7571127.md): - Schemas [UserFieldHistoriesMetaWithValidation](https://dev.returning.ai/schema-7571128.md): - Schemas [UserFieldHistoriesMetaWithPagination](https://dev.returning.ai/schema-7571129.md): - Schemas [GetUserFieldHistoriesSuccessResponse](https://dev.returning.ai/schema-7571130.md): - Schemas [CreateUserFieldResponse](https://dev.returning.ai/schema-7571131.md): - Schemas [CreateUserFieldSuccessResponse](https://dev.returning.ai/schema-7571132.md): - Schemas [DeleteUserFieldResponse](https://dev.returning.ai/schema-7571133.md): - Schemas [DeleteUserFieldSuccessResponse](https://dev.returning.ai/schema-7571134.md): - Schemas [UserFieldCreator](https://dev.returning.ai/schema-7571135.md): - Schemas [GetUserFieldResponse](https://dev.returning.ai/schema-7571136.md): - Schemas [GetUserFieldSuccessResponse](https://dev.returning.ai/schema-7571137.md): - Schemas [ValidationErrorItem](https://dev.returning.ai/schema-7571138.md): - Schemas [GetUserFieldsMetaResponse](https://dev.returning.ai/schema-7571139.md): - Schemas [CreatorInfo](https://dev.returning.ai/schema-7571140.md): - Schemas [UserFieldResponse](https://dev.returning.ai/schema-7571141.md): - Schemas [GetUserFieldsSuccessResponse](https://dev.returning.ai/schema-7571142.md): - Schemas [UpdateUserFieldResponse](https://dev.returning.ai/schema-7571143.md): - Schemas [UpdateUserFieldPayload](https://dev.returning.ai/schema-7571144.md): - Schemas [UpdateUserFieldSuccessResponse](https://dev.returning.ai/schema-7571145.md): - Schemas [MetaResponse](https://dev.returning.ai/schema-7571146.md): - Schemas [GetUserResponse](https://dev.returning.ai/schema-7571147.md): - Schemas [GetUserSuccessResponse](https://dev.returning.ai/schema-7571148.md): - Outgoing webhooks [Purchased store item](https://dev.returning.ai/schema-9192010.md): - Outgoing webhooks [New message posted to channel](https://dev.returning.ai/schema-9194633.md): - Outgoing webhooks [User visits server](https://dev.returning.ai/schema-9194832.md): - Outgoing webhooks [User join server](https://dev.returning.ai/schema-9194841.md):