listDriverGroups API Endpoint

The listDriverGroups API allows Zendrive customers to look up driver groups and obtain a list of group Ids.

Refer to Zendrive Server APIs for an understanding of how Zendrive server APIs are organized.

List Driver Groups

GET https://api.zendrive.com/v4/groups -H

Look up driver groups and get a list of group IDs.

Query Parameters

Name	Type	Description
start_date	String	Provide a date as YYYY-MM-DD.
interval_type	String	Choose day, week, or month

Headers

Name	Type	Description
Authorization*	String	API KEY <APIKEY>

200

{
    "group_ids": [
        "groupid1",
        "groupid2",
        "groupidn",
    ]
}

You must provide Date Range fields (start_date and interval_type). Refer to Set 1 of Date Range, Pagination, and Sorting to understand how date resolution is made and then data is returned.

Response Fields

Response field	Description
group_ids	A collection of all group IDs in the dataset. A group ID is specified in Zendrive SDK initialization to tag a driver as part of a group.

To understand how group_ids are set, refer to Zendrive Driver Attributes.

Sample Response

{
    "group_ids": 
        "groupid1",
        "groupid2",
        "groupidn",
    ]
}