Overview

Fetch a list of all the groups of a company

  • Endpoint: v1/groups
  • Description: Retrieves a list of all groups within the company, including information on each group's name, and members.
  • Use Case: This is useful for administrators to view and manage different groups, allowing them to organize users, vehicles, and assets efficiently for specific operations or locations.

Fetch a specific group using its ID

  • Endpoint: v1/groups/{id}
  • Description: Fetches details of a specific group by its unique ID, including group members and other associated entities.
  • Use Case: Used to view information about a specific group, allowing admins to verify group details and make adjustments as needed.

Create a new group

  • Endpoint: v1/groups
  • Description: Creates a new group within the company, which can include specific users, vehicles, assets, or geofences.
  • Use Case: Useful for setting up dedicated groups for new locations, departments, or projects, organizing resources for better management and tracking.

Update an existing group

  • Endpoint: v1/groups/{id}
  • Description: Updates details of an existing group, such as its name, members, or assigned vehicles/assets.
  • Use Case: Allows admins to modify group details as company needs evolve, such as reassigning users or vehicles when groups are restructured.

Delete an existing group

  • Endpoint: v1/groups/{id}
  • Description: Removes a specific group from the company, along with its associated resources.
  • Use Case: Useful when a group is no longer needed, allowing admins to remove outdated or redundant groups, keeping the system organized.

Fetch a list of the users in a group

  • Endpoint: v1/gropus/{id}/users
  • Description: Retrieves a list of all users within a specific group.
  • Use Case: Allows administrators to see all group members, making it easier to verify or adjust user roles within the group.

Add users to a group

  • Endpoint: v1/groups/{id}/users
  • Description: Adds specified users to an existing group.
  • Use Case: Useful for onboarding new team members to a group, ensuring they have the proper access and permissions needed for their assigned tasks.

Remove users from a group

  • Endpoint: v1/groups/{id}/users
  • Description: Removes specified users from a group, revoking their association with it.
  • Use Case: Used when a user no longer needs to be part of a group, helping maintain accurate group membership.

Fetch a list of all the vehicles in a group

  • Endpoint: v1/groups/{id}/vehicles
  • Description: Lists all vehicles associated with a specific group.
  • Use Case:Allows fleet managers to view vehicles within a group, helping with asset organization and allocation for specific projects or locations.

Add a vehicle to a group

  • Endpoint: v1/groups/{id}/vehicles
  • Description: Associates a vehicle with a specific group, making it part of that group’s resources.
  • Use Case: Useful for assigning vehicles to groups based on location or purpose, enabling better fleet management and tracking.

Delete a vehicle from a group

  • Endpoint: v1/groups/{id}/vehicles
  • Description: Removes a specific vehicle from a group.
  • Use Case: Used when a vehicle needs reassignment or removal from a group, keeping group resources up-to-date.

List all the assets of a group

  • Endpoint: v1/groups/{id}/assets
  • Description: Lists all assets associated with a specific group, such as equipment or other resources.
  • Use Case: Helps asset managers to track assets within groups, improving asset allocation and accountability.

Add assets to an existing group

  • Endpoint: v1/groups/{id}/assets
  • Description: Adds specified assets to a group, associating them for tracking and management purposes.
  • Use Case: Useful when new assets need to be allocated to a group, ensuring they’re included in the relevant operations or locations.

Delete an asset from a group

  • Endpoint: v1/groups/{id}/assets
  • Description: Removes a specific asset from a group, revoking its association.
  • Use Case: Used when an asset no longer belongs to a group, allowing for accurate asset tracking and reducing management overhead.

List all the geofences of the group

  • Endpoint: v1/groups/{id}/geofences
  • Description: Retrieves a list of all geofences associated with a specific group.
  • Use Case: Useful for viewing location-based restrictions or areas relevant to a group, helping in location tracking and compliance.

Add a geofence to an existing group

  • Endpoint: v1/groups/{id}/geofences
  • Description: Adds a new geofence to a specified group, associating it with that group’s resources.
  • Use Case: Allows admins to define geofenced areas for group-specific activities, enhancing location-based controls and monitoring.

Delete a geofence from a group

  • Endpoint: v1/groups/{id}/geofences
  • Description: Removes a specific geofence from a group, revoking its association with that group.
  • Use Case: Used when a geofence is no longer relevant to a group, keeping geofence data organized and up-to-date.