Sign in
Groups

Get groups

Changed on

This endpoint returns a list of all groups in your project. Corresponds to liveblocks.getGroups.

get/groups

Request

  • Base URL: https://api.liveblocks.io/v2
  • URL: https://api.liveblocks.io/v2/groups
  • Auth: none declared

Query parameters

limitinteger

A limit on the number of groups to be returned. The limit can range between 1 and 100, and defaults to 20.

Example:20
startingAfterstring

A cursor used for pagination. Get the value from the nextCursor response of the previous page.

Example:eyJjcmVhdGVkQXQiOjE2NjAwMDA5ODgxMzd9

Response

Success. Returns the list of groups and the next page cursor.

nextCursorstring nullable required

Example response

{
  "data": [
    {
      "type": "group",
      "id": "engineering",
      "organizationId": "org_123456789",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "scopes": {
        "mention": true
      },
      "members": [
        {
          "id": "alice",
          "addedAt": "2024-01-15T10:30:00.000Z"
        }
      ]
    }
  ],
  "nextCursor": null
}

Changes

  • 22a5e987b8c9Revision changes
    • info

      the response property const value true was added for the status

  • 77cd6a75b2b7Revision changes
    • breaking

      for the query request parameter limit, the type changed from number to integer

    • breaking

      response property nextCursor list-of-types was widened by adding types null to media type application/json of response 200

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property const value group was added for the status

    • info

      removed the group enum value from the // response property for the response status