Users List

👥 Get Community Users

Description

This API retrieves a paginated list of users in a given community. It includes both active and inactive members, their roles, status, and permissions.

HTTP Method: GET

Endpoint: api/v1/admin/community/users?start=0&count=30&showInActive=true&sortType=recent

Request Details

Headers

Key	Type	Required	Description
x-api-key	string	Yes	API key provided by the Networked Team.

Query Parameters

Parameters	Type	Required	Description
`sortType`	text	No	`"recent"`
`keyword`	text	No	Keyword match in name, email, or about fields
`personName`	text	No	Filter users by name
`title`	text	No	Job title from user profile
`primaryCompany`	text	No	User’s primary company name
`primarySchool`	text	No	User’s primary school name
`location`	text	No	User's current location
`latitude`	text	No	Latitude value for geographic filtering
`longitude`	text	No	Longitude value for geographic filtering
`industry[0]`	text	No	Industry ID associated with the user
`expertise[0]`	text	No	Expertise ID associated with the user
`employmentType`	text	No	Employment type: `Full-time`, `Part-time`, `Self-employed`, etc.
`expName`	text	No	Name of the company in experience
`expTitle`	text	No	Title in the experience section
`expLocation`	text	No	Location of the experience
`expDescription`	text	No	Description of the experience
`expStartDate`	text	No	Start date of experience in timestamp format
`currentlyWorking`	text	No	Set `true` if user is currently working (default is `false`)
`eduName`	text	No	Education institution name
`eduDegree`	text	No	Education degree (e.g., `Graduate`, `Postgraduate`)
`eduFieldOfStudy`	text	No	Major/field of study
`eduDescription`	text	No	Description of the education
`currentlyStudying`	text	No	Set `true` if currently studying (default is `false`)

Sample Response

{
  "data": {
    "totalUsers": 1,
    "start": 0,
    "count": 1,
    "nextStart": false,
    "content": [
      {
        "name": "user123",
        "email": "user123@yopmail.com",
        "image": "",
        "userId": "6836fc8db386c90012787b69",
        "industries": [],
        "isActive": true,
        "affiliatedTag": {
          "id": "67959032bc6bea0012fdc676",
          "name": "Moderator",
          "roleType": 1
        },
        "status": 1,
        "memberSince": 1748434061353,
        "isGroupAdmin": false,
        "isGroupOwner": false,
      }
    ]
  },
  "error": false,
  "message": "Operation completed successfully"
}

Response Interface

Response Field Descriptions

Key	Type	Description
data.totalUsers	number	Total number of users in the community.
data.start	number	The current pagination start index.
data.count	number	Number of users returned in this request.
data.nextStart	number / boolean	Indicates the next start index for pagination or `false` if no more data.
data.content	array	List of user objects with full metadata.
content[].name	string	Name of the user.
content[].email	string	Email address of the user.
content[].image	string	URL to the user’s profile picture.
content[].userId	string	Unique identifier for the user.
content[].industries	array	Industries associated with the user.
content[].isActive	boolean	Indicates if the user is currently active.
content[].affiliatedTag.id	string	ID of the user's role or tag.
content[].affiliatedTag.name	string	Name of the user's role or tag (e.g., Moderator).
content[].affiliatedTag.roleType	number	Type of role assigned to the user.
content[].status	number	Internal status code for the user.
content[].memberSince	number	Timestamp indicating when the user joined the community.
content[].inGroup	boolean	Indicates if the user is part of any group.
content[].isGroupAdmin	boolean	Indicates if the user is an admin of any group.
content[].isGroupOwner	boolean	Indicates if the user is the owner of any group.
content[].canSendMessage	boolean	Whether the user has permission to send messages.
error	boolean	`false` indicates the operation was successful.
message	string	A message describing the response outcome.

Reference

🔗 Response Codes

Notes

Pagination should be handled using start, count, and nextStart values.

affiliatedTag helps define the user's role and access scope within the community.

👥 Get Community Users#

Description#

Request Details#

Headers#

Query Parameters#

Sample Response#

Response Interface#

Response Field Descriptions#

Reference#

Notes#

Request

Responses