Get community users

Retrieve a paginated list of users in a specific community with optional field selection.

Security Requirements:

Bearer token authentication required

Only community members, administrators, or owners can access this endpoint

User must have COMMUNITY_MEMBER, COMMUNITY_ADMIN, or COMMUNITY_OWNER permission for the specified community

Some properties are not available for all users, depending on the user's privacy settings

Some properties are not available for member permission level

What it is for: Lists users in a community for admin or reporting workflows.
How to use it: Send a GET request to /v1/communities/{communityId}/users with the request body, query parameters, or multipart fields shown below. Authorization: Bearer <apiKey>. The key must be active, unexpired, scoped to the correct community, and include the permission required by this endpoint.
Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.
Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

curl --location 'https://sgtr-integration.returning.ai/apis/v1/communities//users?page=undefined&limit=undefined&_id=undefined&id=undefined&avatar=undefined&displayName=undefined&username=undefined&firstName=undefined&lastName=undefined&email=undefined&isOnline=undefined&lastLogin=undefined'

{ "meta": { "status": "success", "statusCode": 200 }, "message": "Get users success.", "data": [ { "_id": "61100af5c548eb5c7ebc7819", "id": 123456789, "avatar": "https://returning-ai.com/avatar.png", "displayName": "Admin", "username": "admin", "firstName": "John", "lastName": "Doe", "email": "admin@example.com", "isOnline": true, "lastLogin": "2023-12-01T10:30:00Z" }, { "_id": "61100af5c548eb5c7ebc781a", "id": 987654321, "avatar": null, "displayName": "User", "username": "user", "firstName": "Jane", "lastName": "Smith", "email": "user@example.com", "isOnline": false, "lastLogin": "2023-11-30T15:45:00Z" } ] }

Request

Responses