Group list
GET
/group/listRequest
Query Params
page
number
optional
Page number default value = 1 if not passed
limit
number
optional
Number of accounts displayed, default value = 10 if not passed.
q
string
optional
Search by keyword(groupName)
sortBy
string
optional
sort group list by groupName
sortOrder
string
optional
sort group list by groupName with assenging or descending order, eg ASC or DESC
Header Params
x-api-key
string
required
required parameter to identify the api Getway
Default:
yFxaTyRTiH7YBUYeYiEeCYBMRGZA8wk5fsCJxVy1
Request samples
Responses
OK(200)
Bad Request(400)
Unauthorized(401)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
Group list displayed successfully
Data Schema
message
string
optional
Group list displayed successfully
response
object
optional
currentPage
number
optional
current page number
pageLimit
number
optional
page limit
totalRecords
number
optional
total records
totalPages
number
optional
total page
list
array [object {5}]
optional
Example
{
"message": "Group List Displayed Successfully",
"response": {
"currentPage": 1,
"pageLimit": 10,
"totalRecords": 1,
"totalPages": 1,
"list": [
{
"groupId": "groupId",
"groupName": "jay123",
"createdOn": "2022-09-19T10:03:01.646Z",
"companyId": 100138,
"accounts": [
{
"accountId": 9,
"profilePicture": "profilePicture URL",
"accountUsername": "accountUsername",
"accountUrl": "accountUrl",
"color": "#0177b5",
"fbAppInstall": false,
"isLocked": false,
"isReconnect": false,
"loginId": 12345,
"accountMaster": {
"scenario": "suitcase",
"accountName": "LinkedIn Pages"
}
},
{
"accountId": 26,
"profilePicture": "profilePicture URL",
"accountUsername": "accountUsername",
"accountUrl": "accountUrl",
"color": "#0177b5",
"fbAppInstall": false,
"isLocked": false,
"isReconnect": false,
"loginId": 45676,
"accountMaster": {
"scenario": "youtube",
"accountName": "Youtube"
}
}
]
}
]
}
}
Last modified: 18 days ago