FOfolk
Group members

List group members

Changed on

Returns a list of the group members. For a public group, all workspace members are members of the group.

get/v1/groups/{groupId}/members

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/groups/{groupId}/members
  • Auth
    HTTP bearer

Path parameters

groupIdstring required

The identifier of the group. You can retrieve a list of group identifiers using the /v1/groups endpoint.

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Response

A paginated list of the group members. The data.items field contains the list of members, and the data.pagination.nextLink field contains a link to the next page of results, if available.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "usr_bc984b3f-0386-434d-82d7-a91eb6badd71",
        "fullName": "John Doe",
        "email": "john.doe@example.com",
        "role": "contributor"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/groups/grp_bc984b3f-0386-434d-82d7-a91eb6badd71/members?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes