Workplace provides an Account Management API for managing user accounts and a Graph API for managing groups membership, and content that exists within your instance.
Workplace provides an Account Management API for managing user accounts and a Graph API for managing groups membership, and content that exists within your instance.
Get main information about community. Community object as a root Group for the other groups in a Workplace community.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
communityId | String | Community id |
Get a list of all groups for a community.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
communityId | String | Community id |
Get a list of all members for a community.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
communityId | String | Community id |
Add a new group to a community.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
communityId | String | Community id |
name | String | The name of the group to be created. |
description | String | Group description |
privacy | String | The privacy setting of the group. Possible values: OPEN , CLOSED , SECRET . Default CLOSED |
Get main information about group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
Get group members.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
Get group docs.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
Get group posts.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
Add a member to a group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
String | User email |
Remove a member from a group. Removing the last member from a group will schedule that group for deletion.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
String | User email |
Promote a member to admin of a group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
userId | String | User id |
Demote an admin to member of a group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
userId | String | User id |
Create a new Event in a group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
name | String | Event name |
startTime | DatePicker | Event start time. Date format: YYYY-MM-DDTHH:mm:SS |
endTime | DatePicker | Event end time. Date format: YYYY-MM-DDTHH:mm:SS |
description | String | Event description |
location | String | Event location |
Get the comments from a post.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
postId | String | Post id |
Get post main content.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
postId | String | Post id |
Post into a group.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
message | String | Message text |
link | String | Post link |
Tag a user in a group post.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
groupId | String | Group id |
message | String | Tagged text. Example: Hi+@[100013325822531] |
Get main information about member.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
memberId | String | Member id |
Get conversations for a member including messages and attachments.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
memberId | String | Member id |
Delete a specific message in a member’s inbox (requires a member’s impersonate token).
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
memberId | String | Member id |
messageId | String | Message id |
Get a member’s events.
Field | Type | Description |
---|---|---|
accessToken | credentials | The api key obtained from Facebook Workplace |
memberId | String | Member id |