Get driver app settings

Get driver app settings.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Driver App Settings under the Drivers category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /fleet/settings/driver-app

Get driver app settings

cURL

curl --request GET \
  --url https://api.samsara.com/fleet/settings/driver-app \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "driverFleetId": "abc_trucking_co",
    "gamification": false,
    "gamificationConfig": {
      "anonymizeDriverNames": false
    },
    "orgVehicleSearch": false,
    "trailerSelection": true,
    "trailerSelectionConfig": {
      "driverTrailerCreationEnabled": true,
      "maxNumOfTrailersSelected": 7,
      "orgTrailerSearch": false
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

OK response.

data · object · required

The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.

Show child attributes