Sign in
Groups

Get group

Changed on

This endpoint returns a specific group by ID. Corresponds to liveblocks.getGroup.

get/groups/{groupId}

Request

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

Path parameters

groupIdstring required

The ID of the group to retrieve.

Example:engineering

Response

Success. Returns the group.

type'group' required
idstring required
organizationIdstring required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "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"
    },
    {
      "id": "bob",
      "addedAt": "2024-01-16T09:00:00.000Z"
    }
  ]
}

Changes

  • 22a5e987b8c9Revision changes
    • info

      the response property const value true was added for the status

  • 77cd6a75b2b7Revision changes
    • info

      api operation id get-groups-groupId removed and replaced with get-group

    • 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