Skip to main content

GroupPageResult

totalintegerrequired

Total number of items

Example: 15
result object[]required

Array of group items

  • Array [
  • uidstringrequired

    Unique identifier of the group

    Example: 019619df-4768-76b3-8ab3-4414dcf29ff1
    labelstringrequired

    Display label of the group

    Example: Project Managers
    permissions objectrequired

    Map of permission types to permission details

    property name* object
    property name* object
    labelstring

    Label of the permission

    Example: Building A
    uidstring

    UID of the permission

    Example: 019619df-4768-76b3-8ab3-4414dcf29ff1
    users objectrequired
    countintegerrequired

    Number of users in the group

    Example: 12
  • ]
  • GroupPageResult
    {
    "total": 15,
    "result": [
    {
    "uid": "019619df-4768-76b3-8ab3-4414dcf29ff1",
    "label": "Project Managers",
    "permissions": {},
    "users": {
    "count": 12
    }
    }
    ]
    }