Beta APIs

[beta] List driver app workflows

List the driver app workflows configured for the organization. Use the returned workflow IDs to reference workflows from the driver create/update APIs or from the driver workflow assignment API. Workflows are organization-scoped and unique per organization.

<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 Drivers under the Drivers 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/fleet/drivers/workflows

Request

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

Query parameters

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.

limitinteger

The limit for how many objects will be in the response. Default and max for this value is 512 objects.

workflowType'startOfDay' | 'endOfDay' | 'assetSelection' | 'leaveAsset' | 'ridershipSafetyCheck' | 'stopArrival'

Filter the result to workflows of a specific type. When omitted, workflows of all types are returned. Valid values: startOfDay, endOfDay, assetSelection, leaveAsset, ridershipSafetyCheck, stopArrival

Response

OK response.

Example response

{
  "data": [
    {
      "id": "a4db8702-79d5-4396-a717-e301d52ecc11",
      "name": "Pre-trip inspection",
      "workflowType": "startOfDay"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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