Get Community Members

GET 
/social-media-posting/:locationId/community/accounts/:accountId/users

List the members you can publish a post as, for one connected Community channel.

accountId is the Community account ID from the Get Accounts API. Each Community account represents one channel and members are scoped to it: for a private channel only that channel's members are returned, for a public channel the group's members are. Always list members per account rather than reusing one list across accounts.

Pass a returned contactId as communityPostDetails.postAsUser[accountId].id when creating a post. Only members who can publish are returned — a member must be Active and hold a role in the group.

Results are paginated; meta.nextPage is null on the last page.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

accountId stringrequired

Community account Id, from the Get Accounts API

searchText string

Filter members by name. Communities matches on 2 or more characters; a less than 2 characters value returns no members.

Possible values: >= 2 characters

pageNo number

Page number for pagination. Defaults to 1.

Possible values: >= 1

Default value:1

limit number

Number of members per page. Defaults to 10, max 100.

Possible values: >= 1 and <= 100

Default value:10

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Success or Failure

statusCodenumberrequired

Status Code

messagestringrequired

Message

resultsobject

Requested Results

Example (auto)

{
  "success": true,
  "statusCode": 200,
  "message": "Fetched Community Members",
  "results": {
    "users": [
      {
        "contactId": "YBjxnYiXJKmoyV7WDjjG",
        "fullName": "Jane Cooper",
        "avatar": "https://storage.googleapis.com/revex-communities/avatars/jane.png",
        "role": "admin",
        "status": "Active"
      }
    ],
    "meta": {
      "currentPage": 1,
      "nextPage": null,
      "prevPage": null,
      "total": 1
    }
  }
}