List group members

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns one page of a group's members, sorted by email. Set search to match part of a member's email or name.

To page, keep requesting with offset increased by the number of members returned while has_more is true.

Members your identity provider sent who don't have a Base44 account in the workspace yet aren't listed. List workspace groups counts them in unresolved_count.

This is limited to 120 requests per minute, shared with List workspace groups. A signed-in session has its own limit, and every personal access token for the workspace shares one. Some workspaces have a different limit.

<Note>Call this as an owner, admin, or editor of the workspace, with a personal access token for that workspace sent as a Bearer token, or from a signed-in session. A read-only token is refused even though this endpoint only reads, and workspace API keys aren't accepted.</Note>

get/api/workspace/groups/{group_id}/members

Path parameters

group_idstring required

ID of the group whose members to list. Get it from id in List workspace groups.

ID of the group whose members to list. Get it from id in List workspace groups.

Query parameters

workspaceIdstring required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

searchstring nullable

Only return members whose email or name contains this text, ignoring case. Up to 254 characters.

Only return members whose email or name contains this text, ignoring case. Up to 254 characters.

offsetinteger

Number of members to skip. Defaults to 0.

Number of members to skip. Defaults to 0.

limitinteger

Number of members to return, from 1 to 200. Defaults to 50.

Number of members to return, from 1 to 200. Defaults to 50.

Response

One page of the group's members.

totalinteger required

Number of members that match search, across all pages.

has_moreboolean required

Whether more members follow this page.

Example response

{
  "members": [
    {
      "email": "dana@acme.com",
      "full_name": "Dana Levi",
      "user_id": "6820f41be7b91d003c45a20a"
    }
  ],
  "total": 12
}

Changes

Changed in 1 of the 39 revisions of this API.1