GET api/v4/detailedgroup?userID={userID}&token={token}&groupID={groupID}&childGroups={childGroups}&userIDQueried={userIDQueried}

Get a list of groups by group id or user id. If using group ID you can specify if you would like to pull back child groups

Request Information

URI Parameters

Name	Description	Type	Additional information
userID	The userid being used for authentication	unsigned integer	Required
token	The token being used for authentication	string	Required
groupID	The group id being searched for. Group Id takes priority over user id	unsigned integer	Default value is 0
childGroups	Bool value to specify if you want to pull back child groups when querying on group id	boolean	Default value is False
userIDQueried	The user id being used in search. Group Id takes priority over user id	unsigned integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

A list of groups

Collection of Group

Name	Description	Type	Additional information
ChildCount	The number of child groups this group has	integer	None.
VehicleCount	The amount of vehicles in this group	integer	None.
AssetCount	The amount of assets in this group	integer	None.
AreaCount	The amount of areas in this group	integer	None.
MovementAlertCount	The amount of Movement Alerts in this group	integer	None.
SpeedThresholdAlertCount		integer	None.
EventAlertCount		integer	None.
OtherAlertCount		integer	None.
POIAlertCount	The amount of poi Alerts in this group	integer	None.
TachoAlertCount		integer	None.
V5ScheduledReportCount		integer	None.
CustomerCode	The customer code of this group	string	None.
CrashEmailAddress	The email address where crash alerts for this group are sent	string	None.
CrashTemplate	The PDF template used for crash alerts	string	None.
ID	The unique group ID	unsigned integer	None.
OwnerUserID	The owner of the group user id	unsigned integer	None.
ParentGroupID	The parent ID of this group	unsigned integer	None.
Name	The name of the group	string	Required String length: inclusive between 0 and 50
Icon	The icon used for this group	string	None.
Created	The time when this group was created	date	None.
ActiveFlag	Flag indicating if this group is active	boolean	None.
Sys_Modified	The time when this group was edited	date	None.
MobileAppEnabled	If this group is mobile app enabled	boolean	None.
MobileBrandingID	A branding id used on mobile applications	unsigned integer	None.
AccountsLockout	Indicated if the group has been locked	boolean	None.
CrashPDFGenerationSettings		CrashPDFGenerationSettings	None.
UrbanWeighting		integer	None.
NightWeighting		integer	None.
AccelWeighting		integer	None.
DecelWeighting		integer	None.
SpeedWeighting		integer	None.
CameraAlertEmailAddress	The email where camera missing alerts are sent	string	None.
HomePOIID	A home POI ID	unsigned integer	None.
SummariseCo2		boolean	None.
Usdot		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ChildCount": 1,
    "VehicleCount": 2,
    "AssetCount": 3,
    "AreaCount": 4,
    "MovementAlertCount": 5,
    "SpeedThresholdAlertCount": 6,
    "EventAlertCount": 7,
    "OtherAlertCount": 8,
    "POIAlertCount": 9,
    "TachoAlertCount": 10,
    "V5ScheduledReportCount": 11,
    "CustomerCode": "sample string 12",
    "CrashEmailAddress": "sample string 13",
    "CrashTemplate": "sample string 14",
    "ID": 15,
    "OwnerUserID": 16,
    "ParentGroupID": 17,
    "Name": "sample string 18",
    "Icon": "sample string 19",
    "Created": "2025-11-04T14:32:42.7740358+00:00",
    "ActiveFlag": true,
    "Sys_Modified": "2025-11-04T14:32:42.7740358+00:00",
    "MobileAppEnabled": true,
    "MobileBrandingID": 24,
    "AccountsLockout": true,
    "CrashPDFGenerationSettings": 1,
    "UrbanWeighting": 26,
    "NightWeighting": 27,
    "AccelWeighting": 28,
    "DecelWeighting": 29,
    "SpeedWeighting": 30,
    "CameraAlertEmailAddress": "sample string 31",
    "HomePOIID": 32,
    "SummariseCo2": true,
    "Usdot": "sample string 34"
  },
  {
    "ChildCount": 1,
    "VehicleCount": 2,
    "AssetCount": 3,
    "AreaCount": 4,
    "MovementAlertCount": 5,
    "SpeedThresholdAlertCount": 6,
    "EventAlertCount": 7,
    "OtherAlertCount": 8,
    "POIAlertCount": 9,
    "TachoAlertCount": 10,
    "V5ScheduledReportCount": 11,
    "CustomerCode": "sample string 12",
    "CrashEmailAddress": "sample string 13",
    "CrashTemplate": "sample string 14",
    "ID": 15,
    "OwnerUserID": 16,
    "ParentGroupID": 17,
    "Name": "sample string 18",
    "Icon": "sample string 19",
    "Created": "2025-11-04T14:32:42.7740358+00:00",
    "ActiveFlag": true,
    "Sys_Modified": "2025-11-04T14:32:42.7740358+00:00",
    "MobileAppEnabled": true,
    "MobileBrandingID": 24,
    "AccountsLockout": true,
    "CrashPDFGenerationSettings": 1,
    "UrbanWeighting": 26,
    "NightWeighting": 27,
    "AccelWeighting": 28,
    "DecelWeighting": 29,
    "SpeedWeighting": 30,
    "CameraAlertEmailAddress": "sample string 31",
    "HomePOIID": 32,
    "SummariseCo2": true,
    "Usdot": "sample string 34"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroup xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Group>
    <ChildCount>1</ChildCount>
    <VehicleCount>2</VehicleCount>
    <AssetCount>3</AssetCount>
    <AreaCount>4</AreaCount>
    <MovementAlertCount>5</MovementAlertCount>
    <SpeedThresholdAlertCount>6</SpeedThresholdAlertCount>
    <EventAlertCount>7</EventAlertCount>
    <OtherAlertCount>8</OtherAlertCount>
    <POIAlertCount>9</POIAlertCount>
    <TachoAlertCount>10</TachoAlertCount>
    <V5ScheduledReportCount>11</V5ScheduledReportCount>
    <CustomerCode>sample string 12</CustomerCode>
    <CrashEmailAddress>sample string 13</CrashEmailAddress>
    <CrashTemplate>sample string 14</CrashTemplate>
    <ID>15</ID>
    <OwnerUserID>16</OwnerUserID>
    <ParentGroupID>17</ParentGroupID>
    <Name>sample string 18</Name>
    <Icon>sample string 19</Icon>
    <Created>2025-11-04T14:32:42.7740358+00:00</Created>
    <ActiveFlag>true</ActiveFlag>
    <Sys_Modified>2025-11-04T14:32:42.7740358+00:00</Sys_Modified>
    <MobileAppEnabled>true</MobileAppEnabled>
    <MobileBrandingID>24</MobileBrandingID>
    <AccountsLockout>true</AccountsLockout>
    <CrashPDFGenerationSettings>SpeedFiltering</CrashPDFGenerationSettings>
    <UrbanWeighting>26</UrbanWeighting>
    <NightWeighting>27</NightWeighting>
    <AccelWeighting>28</AccelWeighting>
    <DecelWeighting>29</DecelWeighting>
    <SpeedWeighting>30</SpeedWeighting>
    <CameraAlertEmailAddress>sample string 31</CameraAlertEmailAddress>
    <HomePOIID>32</HomePOIID>
    <SummariseCo2>true</SummariseCo2>
    <Usdot>sample string 34</Usdot>
  </Group>
  <Group>
    <ChildCount>1</ChildCount>
    <VehicleCount>2</VehicleCount>
    <AssetCount>3</AssetCount>
    <AreaCount>4</AreaCount>
    <MovementAlertCount>5</MovementAlertCount>
    <SpeedThresholdAlertCount>6</SpeedThresholdAlertCount>
    <EventAlertCount>7</EventAlertCount>
    <OtherAlertCount>8</OtherAlertCount>
    <POIAlertCount>9</POIAlertCount>
    <TachoAlertCount>10</TachoAlertCount>
    <V5ScheduledReportCount>11</V5ScheduledReportCount>
    <CustomerCode>sample string 12</CustomerCode>
    <CrashEmailAddress>sample string 13</CrashEmailAddress>
    <CrashTemplate>sample string 14</CrashTemplate>
    <ID>15</ID>
    <OwnerUserID>16</OwnerUserID>
    <ParentGroupID>17</ParentGroupID>
    <Name>sample string 18</Name>
    <Icon>sample string 19</Icon>
    <Created>2025-11-04T14:32:42.7740358+00:00</Created>
    <ActiveFlag>true</ActiveFlag>
    <Sys_Modified>2025-11-04T14:32:42.7740358+00:00</Sys_Modified>
    <MobileAppEnabled>true</MobileAppEnabled>
    <MobileBrandingID>24</MobileBrandingID>
    <AccountsLockout>true</AccountsLockout>
    <CrashPDFGenerationSettings>SpeedFiltering</CrashPDFGenerationSettings>
    <UrbanWeighting>26</UrbanWeighting>
    <NightWeighting>27</NightWeighting>
    <AccelWeighting>28</AccelWeighting>
    <DecelWeighting>29</DecelWeighting>
    <SpeedWeighting>30</SpeedWeighting>
    <CameraAlertEmailAddress>sample string 31</CameraAlertEmailAddress>
    <HomePOIID>32</HomePOIID>
    <SummariseCo2>true</SummariseCo2>
    <Usdot>sample string 34</Usdot>
  </Group>
</ArrayOfGroup>