SAsamsara
Coaching

Get driver coach assignments.

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

<b>Rate limit:</b> 10 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select Read Coaching under the Coaching category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

get/coaching/driver-coach-assignments

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

driverIdsstring[]

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.

coachIdsstring[]

Optional string of comma separated IDs of the coaches.

includeExternalIdsboolean

Optional boolean indicating whether to return external IDs on supported entities

afterstring

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

OK response.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.