account list
GET
/accounts/listThis endpoint will display list of accounts
Request
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(Account user name)
groupId
string
optional
Filter accounts by groupId (groupId = 123-456-789, 123-456-789, ... )
clientId
string
optional
clientId to identify perticular team member and client
platform
string
optional
Filter accounts by platform ( platformId = 5, 9, 13, ... )
sortBy
string
optional
sort account list by loginId, accountUsername, eg loginId ASC, accountUsername DESC
onlyAccountData
string
optional
Get only accountData, true or false
team
string
optional
teamIds
multiFilter
string
optional
multifilter is given or Not.
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
Accounts list displayed successfully
Data Schema
message
string
optional
Accounts 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 {30}]
optional
Example
{
"message": "Accounts list displayed successfully",
"response": {
"currentPage": 1,
"pageLimit": 10,
"totalRecords": 1,
"totalPages": 1,
"list": [
{
"loginId": 21452,
"accountId": 14,
"accountUsername": "testing",
"accountUrl": "https://www.pinterest.com/accountUsername/testing/",
"profilePicture": "https://i.pinimg.com/60x60/6f/f4/3f/6ff43f8a801281d7e6fa8ddb78b4068a.jpg",
"isPaused": "N",
"profileUniqueId": 755127199929052700,
"uniqueId": 755127131209850400,
"expiryHeader": 0,
"accessToken": "Ag4ir92vvbkthrNpODwrn69GeFOmFZJ5hsy6_hlCgfVgSKACTQp6wDAAAa4pRY2iHypgbpMAAAAA",
"pageAccessToken": null,
"accessSecret": "",
"systemBaseStatus": "Y",
"pageId": "",
"color": "#0177b5",
"isLocked": "N",
"inboxCount": 0,
"fbAppInstall": "N",
"isBlocked": "N",
"shortenerId": 2,
"shortenerMaster": {
"shortenerScenario": "bitly",
"shortenerName": "Bitly"
},
"errors": 0,
"queued": 0,
"hasAnalytics": "Y",
"hasInbox": "N",
"accessType": "O",
"inboxAccess": "Y",
"analyticsAccess": "Y",
"accountType": "pinterest-p,",
"groups": [
{
"id": 12486,
"group_name": "New Group"
},
{
"id": 12453,
"group_name": "Old Group"
}
]
}
]
}
}
Last modified: 18 days ago