Skip to main content

Get Drivers

GET /tms/drivers

Description​

This endpoint retrieves a list of drivers based on various filtering and sorting criteria. It allows you to query drivers by their location, status, type, role, and more.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The code of the country.
  • userByLocations (string, query, optional): Filter drivers by location.
  • fieldNames (string, query, optional): Specify which fields to return.
  • userId (array[string], query, optional): Filter drivers by their user IDs.
  • userDateRange (string, query, optional): Filter drivers by date range.
  • userStaffByBusinessIds (array[string], query, optional): Filter drivers by business IDs.
  • userByStatuses (string, query, optional): Filter drivers by status. Available values: ACTIVE, DISABLE, DEACTIVATE, DELETE.
  • userByTypes (string, query, optional): Filter drivers by type.
  • userByRoles (string, query, optional): Filter drivers by role.
  • userSearch (string, query, optional): Search for drivers by keyword.
  • orderBy (string, query, optional): Specify the order of results.
  • limit (string, query, optional): Limit the number of results returned.
  • page (integer, query, optional): Specify the page number for pagination.

Responses​

  • 200 OK
    • Media type: Controls Accept header.
    • Example Value:
{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

400 Bad Request​

Description: Invalid request Media type: None

404 Not Found​

Description: Resource not found Media type: None

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/drivers \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!