List group shares

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

Returns the workspace groups the app is shared with.

Every member of a shared group can use the app. A member's role in the app is the highest of the role you gave them directly and the roles of all the groups they're in that the app is shared with. Change a group's role with Update group share, or stop sharing with Remove group share.

The response lists every share at once, with no paging. You need editor access to the app, and an editor or admin role in the app's workspace.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

get/api/apps/{app_id}/group-shares

Path parameters

app_idstring required

ID of the app.

ID of the app.

Response

The app's group shares.

Example response

{
  "shares": [
    {
      "created_by": "jane@acme.com",
      "created_date": "2026-09-14T09:21:37.512000",
      "group_id": "68c9a0f1d2e4b5001f3a7c90",
      "group_name": "Sales team",
      "group_source": "custom",
      "id": "68d1c2e4a9b7f3001e5c8a41",
      "member_count": 12,
      "role": "user",
      "unresolved_count": 0
    }
  ]
}

Changes

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