Members /group/{group-id}/members

The members of a group.

Reading

GET /group/{group-id}/members HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to retrieve the parent group are required.

Fields

An array of User objects who are members of the group, in addition to the following field :


Name Description Type

admin

Set to true if the user is an admin of the group.

boolean

Publishing

POST /group/{group-id}/members HTTP/1.1
Host: localhost:3000

Permissions

  • An access token (pointing to an user) with manage_groups permission is required.
  • At least one of the following criteria must be met :
    • The parent group is owned by the current person.
    • The current person is a admin member of the parent group.
    • The current person is an admin (with MANAGE permission) of the workspace at witch is attached the parent group.

Fields

Name Description Type

users

An array of User IDs to invite to the group.
Must be some Users belonging to the current person workspace, who haven't already been invited to the parent group and not owner or member of it.

User[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.

Updating

You can't update members using this edge. If you want to set admin permission to users, use the /group/admins edge.

Deleting

DELETE /group/{group-id}/members HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to publish members are required.

Fields

Name Description Type

users

An array of User IDs to delete from the group.
Must be Users who are members of the group or invited to it.

User[]

Response

If successful :

{
    "success": true
}

Otherwise a relevant error message will be returned.