Get driver coach assignments.

This endpoint will return coach assignments for your organization based on the parameters passed in. Results are paginated.

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

To use this endpoint, select Read Coaching under the Coaching 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 /coaching/driver-coach-assignments

Get driver coach assignments.

cURL

curl --request GET \
  --url https://api.samsara.com/coaching/driver-coach-assignments \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "coachId": "45646",
      "createdAtTime": "2019-06-13T19:08:25Z",
      "driver": {
        "driverId": "0987",
        "externalIds": {}
      },
      "updatedAtTime": "2019-06-13T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

driverIds · string[]

Optional string of comma separated IDs of the drivers. This can be either a unique Samsara driver ID or an external ID for the driver.

coachIds · string[]

Optional string of comma separated IDs of the coaches.

includeExternalIds · boolean

Optional boolean indicating whether to return external IDs on supported entities

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

200

application/json

OK response.

data · object[] · required

List of driver coach assignment objects

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes