SAsamsara
Legacy APIs

[legacy] Get all defects

Note: This is a legacy endpoint, consider using this endpoint instead. The endpoint will continue to function as documented.

Returns a list of DVIR defects in an organization, filtered by creation time. The maximum time period you can query for is 30 days.

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.

To use this endpoint, select Read Defects under the Maintenance 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>

get/fleet/defects/history

Request

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

Query parameters

limitinteger

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

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.

startTimestring required

A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum time period you can query for is 30 days.

endTimestring required

An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum time period you can query for is 30 days.

isResolvedboolean

A filter on the data based on resolution status. Example: isResolved=true

Response

List of all DVIR defects in the organization

Example response

{
  "data": [
    {
      "comment": "Air Compressor not working",
      "createdAtTime": "2020-01-27T07:06:25Z",
      "defectType": "Air Compressor",
      "id": "18",
      "isResolved": true,
      "mechanicNotes": "Extremely large oddly shaped hole in passenger side window.",
      "mechanicNotesUpdatedAtTime": "2020-01-27T07:06:25Z",
      "resolvedAtTime": "2020-01-27T07:06:25Z",
      "resolvedBy": {
        "id": "11",
        "name": "Christopher 'The Handyman' Zhen"
      },
      "trailer": {
        "id": "123456789",
        "name": "Midwest Trailer #5"
      },
      "vehicle": {
        "ExternalIds": {
          "maintenanceId": "250020",
          "payrollId": "ABFS18600"
        },
        "id": "123456789",
        "name": "Midwest Truck #4"
      }
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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