List Groups Members (POST)

POST

Lists the members in a group.

Request

This endpoint expects an object.

groupstringRequiredformat: "id"

ID of the group for which to list members.

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

The maximum number of members to return. If not set, then the default is ‘50’.

modeenumOptional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Response

List of group members.

memberslist of objects

List of members.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

POST

1 curl -X POST https://api.devrev.ai/groups.members.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "group": "foo"
6 }'

200groupsGroupMembersListPostExample

1 {
2   "members": [
3     {
4       "member": {
5         "display_id": "foo",
6         "id": "foo",
7         "display_name": "foo",
8         "display_picture": {
9           "display_id": "foo",
10           "id": "foo",
11           "file": {
12             "type": "foo",
13             "name": "foo",
14             "size": 42
15           }
16         },
17         "email": "foo",
18         "full_name": "foo",
19         "state": "active"
20       },
21       "member_rev_org": {
22         "id": "foo",
23         "display_id": "foo",
24         "display_name": "foo"
25       }
26     }
27   ],
28   "next_cursor": "foo",
29   "prev_cursor": "foo"
30 }

Remove Groups Members

Up Next

Built with

1	curl -X POST https://api.devrev.ai/groups.members.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"group": "foo"
6	}'

1	{
2	"members": [
3	{
4	"member": {
5	"display_id": "foo",
6	"id": "foo",
7	"display_name": "foo",
8	"display_picture": {
9	"display_id": "foo",
10	"id": "foo",
11	"file": {
12	"type": "foo",
13	"name": "foo",
14	"size": 42
15	}
16	},
17	"email": "foo",
18	"full_name": "foo",
19	"state": "active"
20	},
21	"member_rev_org": {
22	"id": "foo",
23	"display_id": "foo",
24	"display_name": "foo"
25	}
26	}
27	],
28	"next_cursor": "foo",
29	"prev_cursor": "foo"
30	}