Skip to main content
OAuth | CommunityVersion: 2021-04-15

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.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:socialplanner/oauth.readonly
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available options2021-04-15
Example:2021-07-28

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
accountIdstringrequired

Community account Id, from the Get Accounts API

Example:aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496

Query Parameters

searchTextstring

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

Possible values: >= 2 characters

Example:jane
pageNonumber

Page number for pagination. Defaults to 1.

Possible values: >= 1

Default:1
Example:1
limitnumber

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

Possible values: >= 1 and <= 100

Default:10
Example:10

Response

Successful response

successbooleanrequired

Success or Failure

Example:true
statusCodenumberrequired

Status Code

Example:200
messagestringrequired

Message

Example:Fetched Community Members
resultsobject

Requested Results