List vehicle groups

Returns the vehicle groups visible to the organization the API key belongs to: the groups it created and the groups other organizations share with it.

Input. sharing is optional: true keeps only the groups shared between organizations, false only the others. Omit it for every group.

Response. 200 with an array of groups, the most recently changed first, without their member ids; Get a vehicle group returns those. memberCount counts the vehicles of a group that the API key may see. An empty array means the organization has no vehicle group that matches.

Notes. Private groups, visible only to the users they are shared with, are left out. Time fields are Unix epoch milliseconds, UTC.

Request examples

GET /v1/vehicle-api/groups
GET /v1/vehicle-api/groups?sharing=true
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

true keeps only the groups shared between organizations, false only the others. Omit it for every group.

Responses

400

sharing is not true or false.

401

Missing or invalid API key.

403

Forbidden - Insufficient permissions to access this resource

429

Too many requests. Try again later.

500

Internal server error.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json