Samsara

App · 20 actions

Read fleet drivers, vehicles, routes, addresses, tags and webhooks; manage drivers, addresses and tags.

Actions

ActionWhat it does
Create addressCreate address.
Create driverCreate driver.
Create tagCreate tag.
Delete addressDelete address.
Delete tagDelete tag.
Get addressGet address.
Get driverGet driver.
Get routeGet route.
Get tagGet tag.
Get vehicleGet vehicle.
Get webhookGet webhook.
List addressesList addresses.
List driversList drivers.
List routesList routes.
List tagsList tags.
List vehiclesList vehicles.
List webhooksList webhooks.
Update addressUpdate address.
Update driverUpdate driver.
Update tagUpdate tag.

Create address

Create address.

Inputs

NamenametextRequired
Name.
Formatted addressformatted_addresstextRequired
Formatted address.
Latitudelatitudenumber
Leave empty to find the center from Formatted address. Set both Latitude and Longitude to override it.From -90 to 90.
Longitudelongitudenumber
Leave empty to find the center from Formatted address. Set both Latitude and Longitude to override it.From -180 to 180.
Radius metersradius_metersnumberRequired
Circle radius in meters, from 1 to 10,000.From 1 to 10000.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "formattedAddress": "example",
      "geofence": {},
      "id": "example",
      "latitude": 0,
      "longitude": 0,
      "name": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create driver

Create driver.

Inputs

NamenametextRequired
Name.
UsernameusernametextRequired
Username.
PasswordpasswordtextRequired
Password.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "driverActivationStatus": "example",
      "email": "example",
      "id": "example",
      "name": "example",
      "phone": "example",
      "username": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create tag

Create tag.

Inputs

NamenametextRequired
Name.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "parentTagId": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete address

Delete address.

Inputs

Addressaddress_idtextRequired
Choose the address or use an ID from a previous step.

Outputs

datanull
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Delete tag

Delete tag.

Inputs

Tagtag_idtextRequired
Choose the tag or use an ID from a previous step.

Outputs

datanull
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Get address

Get address.

Inputs

Addressaddress_idtextRequired
Choose the address or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "formattedAddress": "example",
      "geofence": {},
      "id": "example",
      "latitude": 0,
      "longitude": 0,
      "name": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get driver

Get driver.

Inputs

Driverdriver_idtextRequired
Choose the driver or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "driverActivationStatus": "example",
      "email": "example",
      "id": "example",
      "name": "example",
      "phone": "example",
      "username": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get route

Get route.

Inputs

Routeroute_idtextRequired
Choose the route or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "scheduledEndTime": "example",
      "scheduledStartTime": "example",
      "stops": []
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get tag

Get tag.

Inputs

Tagtag_idtextRequired
Choose the tag or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "parentTagId": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get vehicle

Get vehicle.

Inputs

Vehiclevehicle_idtextRequired
Choose the vehicle or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "licensePlate": "example",
      "name": "example",
      "notes": "example",
      "vin": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get webhook

Get webhook.

Inputs

Webhookwebhook_idtextRequired
Choose the webhook or use an ID from a previous step.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "url": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

List addresses

List addresses. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List drivers

List drivers. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List routes

List routes. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List tags

List tags. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List vehicles

List vehicles. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

List webhooks

List webhooks. Returns one page; use next_cursor to continue.

Inputs

Next page cursoraftertext
Leave empty for the first page; use next_cursor from the previous result to continue.
Results per pagelimitnumber
Maximum records in this page. Leave empty for the service default.From 1 to 512.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "endCursor": "example",
      "hasNextPage": false
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update address

Update address.

Inputs

Addressaddress_idtextRequired
Choose the address or use an ID from a previous step.
NamenametextRequired
Name.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "formattedAddress": "example",
      "geofence": {},
      "id": "example",
      "latitude": 0,
      "longitude": 0,
      "name": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update driver

Update driver.

Inputs

Driverdriver_idtextRequired
Choose the driver or use an ID from a previous step.
NamenametextRequired
Name.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "driverActivationStatus": "example",
      "email": "example",
      "id": "example",
      "name": "example",
      "phone": "example",
      "username": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update tag

Update tag.

Inputs

Tagtag_idtextRequired
Choose the tag or use an ID from a previous step.
NamenametextRequired
Name.

Outputs

dataobject
Service response or returned records.
has_moretrue/false
Whether another page is available.
next_cursortext
Cursor for the next page; empty when finished.
Example output
{
  "data": {
    "data": {
      "id": "example",
      "name": "example",
      "parentTagId": "example"
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page