Response

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": 123,
            "code": "ALL_USERS",
            "name": "All Users",
            "description": "All users in your account are automatically added to this group.",
            "user_count": 11,
            "lock_update": 1,
            "lock_delete": 1,
            "lock_grant_revoke_global_permissions": 0,
            "lock_grant_revoke_licenses": 0,
            "lock_add_remove_users": 1,
            "created_at": "2017-07-04T12:36:39-0400",
            "modified_at": "2017-07-04T12:36:39-0400"
        }
    ],
    "meta": {
        "count": 1,
        "limit": 25,
        "total_pages": 1
    }
}

The response will contain a users collection:

Body ParametersTypeDescription
dataArrayThe collection of user groups
metaObjectSee: Pagination

Each user group in the collection will have properties:

Body ParametersTypeDescription
idIntegerThe user group identifier
codeStringThe user group code
nameStringThe user group name
descriptionStringThe user group description
user_countIntegerThe number of users included in the user group
lock_deleteBooleanThe user group cannot be deleted if this lock is set
lock_grant_revoke_global_permissionsBoolean
lock_grant_revoke_licensesBoolean
lock_add_remove_usersBooleanUsers cannot be removed from this user group if this lock is set
created_atDateTimeThe user group creation time
modified_atDateTimeThe user group last updated time