View All Groups

This API provides you with information about all groups present in your account.


Sample Request


API Response Explanation

FieldDescriptionData Type
generatedAtInMillisTime in UTC milliseconds when the API request is madeLong
dataThe object consists of metadata of the group.Object
groupIdUnique identifier representing the groupString
customerIdUnique identifier representing the customerLong
parentIdUnique identifier representing the parent groupString
parentNameName of the parent groupString
nameName of the groupString
descriptionBrief description of the groupString
configIdUnique identifier of the configurationString
parentGroupObject represents the metedata of the parent groupGroupLiteVO
groupIdunique identifier of the parent groupString
nameName of the parent groupString
configNameName of the configurationString
createdByUnique identifier of the user created the groupString
createdAtCreated time of the group in UTC millisecondsTimestamp
lastModifiedByUnique identifier of the user updated the group lastString
lastModifiedAtModified time of the group in UTC millisecondsTimestamp
deletedBoolean value representing whether the group is deleted.
True = Deleted
False = Not Deleted
deletedAtDeleted time in UTC millisecondsTimestamp
colorText color of the map icon.
#ffffff by default
bgColorBackground color of the map icon
#000000 by default
adminUsersFor internal useString
userListArray of objects representing the meta-data of the administratorsList
idUnique identifier representing the administratorsString
firstNameFirst name of the 1st administratorString
lastNameLast name of the 1st administratorString
childGroupIdsUnique identifier representing the child grouopString
configurationObject representing the meta-data of the configurationConfigurationVO
idUnique identifier representing the configurationString
nameName of the configurationString
descriptionDescription of the configurationString
trackingScheduleFor internal useboolean
groupListFor internal useList
groupListStringFor internal useString
hrsOfOperationFor internal useList
deviceConfigurationsFor internal useSet
ssodefaultFor internal useboolean
errorError description - if anyList
recordsFilteredNumber of records fetchedInteger
Click Try It! to start a request and see the response here!