Samsara Incidents API

openapi: 3.2.0
info:
  description: Gain greater visibility by connecting your fleets, equipment, sites, and people.
  title: Samsara Incidents API
  version: '2024-11-18'
servers:
- url: https://api.samsara.com/
- url: https://api.eu.samsara.com/
security:
- AccessTokenHeader: []
tags:
- name: Incidents
paths:
  /alerts/incidents/stream:
    get:
      description: "Get Alert Incidents for specific Alert Configurations over a specified period of time.\n\n <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>).\n\nTo use this endpoint, select **Read Alerts** under the Alerts 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>\n \n\n **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."
      operationId: getIncidents
      parameters:
      - description: Required RFC 3339 timestamp that indicates when to begin receiving data. This will be based on updatedAtTime.
        in: query
        name: startTime
        required: true
        schema:
          type: string
      - description: Required array of alert configuration ids to return incident data for.
        explode: true
        in: query
        name: configurationIds
        required: true
        schema:
          items:
            type: string
          maxItems: 50
          minItems: 1
          type: array
        style: form
      - description: Optional RFC 3339 timestamp to stop receiving data. Defaults to now if not provided. This will be based on updatedAtTime.
        in: query
        name: endTime
        schema:
          type: string
      - description: ' 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.'
        in: query
        name: after
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsResponseBody'
          description: OK response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsUnauthorizedErrorResponseBody'
          description: Unauthorized response.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsNotFoundErrorResponseBody'
          description: Not Found response.
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsMethodNotAllowedErrorResponseBody'
          description: Method Not Allowed response.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsTooManyRequestsErrorResponseBody'
          description: Too Many Requests response.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsInternalServerErrorResponseBody'
          description: Internal Server Error response.
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsNotImplementedErrorResponseBody'
          description: Not Implemented response.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsBadGatewayErrorResponseBody'
          description: Bad Gateway response.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsServiceUnavailableErrorResponseBody'
          description: Service Unavailable response.
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsGatewayTimeoutErrorResponseBody'
          description: Gateway Timeout response.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertsGetIncidentsBadRequestErrorResponseBody'
          description: Bad Request response.
      summary: Get Alert Incidents.
      tags:
      - Incidents
components:
  schemas:
    FormsFieldInputObjectResponseBody:
      description: Forms input field object.
      properties:
        assetValue:
          $ref: '#/components/schemas/FormsAssetValueObjectResponseBody'
        checkBoxesValue:
          $ref: '#/components/schemas/FormsCheckBoxesValueObjectResponseBody'
        dateTimeValue:
          $ref: '#/components/schemas/FormsDateTimeValueObjectResponseBody'
        id:
          description: ID of the forms input field object.
          example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7
          format: uuid
          type: string
        issue:
          $ref: '#/components/schemas/FormsIssueCreatedByFieldObjectResponseBody'
        label:
          description: Forms input field label.
          example: Engine Hours
          type: string
        mediaList:
          description: List of forms media record objects.
          items:
            $ref: '#/components/schemas/FormsMediaRecordObjectResponseBody'
          type: array
        mediaValue:
          $ref: '#/components/schemas/FormsMediaValueObjectResponseBody'
        multipleChoiceValue:
          $ref: '#/components/schemas/FormsMultipleChoiceValueObjectResponseBody'
        note:
          description: A note attached to the field input.
          example: Fire and oil can lead to an accident.
          type: string
        numberValue:
          $ref: '#/components/schemas/FormsNumberValueObjectResponseBody'
        personValue:
          $ref: '#/components/schemas/FormsPersonValueObjectResponseBody'
        signatureValue:
          $ref: '#/components/schemas/FormsSignatureValueObjectResponseBody'
        tableValue:
          $ref: '#/components/schemas/FormsTableValueObjectResponseBody'
        textValue:
          $ref: '#/components/schemas/FormsTextValueObjectResponseBody'
        type:
          description: 'Type of the field.  Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table`'
          enum:
          - number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table
          example: number
          type: string
      required:
      - id
      - type
      type: object
    WorkflowPolygonResponseBody:
      description: Information about a polygon geofence. This field is only needed if the geofence is a polygon.
      properties:
        vertices:
          description: The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.
          items:
            $ref: '#/components/schemas/VertexResponseBody'
          type: array
      type: object
    WorkflowGeofenceResponseBody:
      description: The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.
      properties:
        circle:
          $ref: '#/components/schemas/WorkflowCircleResponseBody'
        polygon:
          $ref: '#/components/schemas/WorkflowPolygonResponseBody'
        settings:
          $ref: '#/components/schemas/SettingsResponseBody'
      type: object
    FormsTableRowObjectResponseBody:
      description: Defines a row in a table form input field.
      properties:
        cells:
          description: List of cells in the row.
          items:
            $ref: '#/components/schemas/FormsTableCellObjectResponseBody'
          type: array
        id:
          description: Unique identifier for the row.
          format: uuid
          type: string
      required:
      - cells
      - id
      type: object
    WorkflowAuthorSignatureObjectResponseBody:
      description: An author signature for DVIRs with a signed time.
      properties:
        signatoryUser:
          $ref: '#/components/schemas/WorkflowSignatoryUserObjectResponseBody'
        signedAtTime:
          description: The time when the DVIR was signed. UTC timestamp in RFC 3339 format.
          example: '2020-01-27T07:06:25Z'
          type: string
        type:
          description: 'Whether the DVIR was submitted by a driver or mechanic.  Valid values: `driver`, `mechanic`'
          enum:
          - driver
          - mechanic
          example: driver
          type: string
      required:
      - signatoryUser
      - signedAtTime
      - type
      type: object
    DashcamDisconnectedResponseBody:
      description: Details specific to Dashcam Disconnected.
      properties:
        driver:
          $ref: '#/components/schemas/alertObjectDriverResponseBody'
        trailer:
          $ref: '#/components/schemas/alertObjectTrailerResponseBody'
        vehicle:
          $ref: '#/components/schemas/alertObjectVehicleResponseBody'
      type: object
    dateTimeValueObjectResponseBody:
      description: The value of a date time field. Only present for date time fields.
      properties:
        dateTime:
          description: Date time value inin RFC 3339 format.
          example: '1975-05-13T14:12:59Z'
          format: date-time
          type: string
      type: object
    signatureValueObjectResponseBody:
      description: The value of a signature field. Only present for signature fields.
      properties:
        id:
          description: Id of the signature field.
          example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7
          type: string
        name:
          description: Name of the signee for a signature field.
          example: John Smith
          type: string
        signedAtTime:
          description: Time the signature was captured in RFC 3339 format.
          example: '2015-01-26T12:08:59Z'
          format: date-time
          type: string
        url:
          description: Url of a signature field's PNG signature image.
          example: https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456
          type: string
      type: object
    alertObjectTrailerResponseBody:
      description: A trailer associated with the alert
      properties:
        attributes:
          description: List of attributes associated with the entity
          items:
            $ref: '#/components/schemas/GoaAttributeTinyResponseBody'
          type: array
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        id:
          description: The ID of the trailer. This is automatically generated when the trailer is created. It cannot be changed.
          example: '494123'
          type: string
        name:
          description: The name of the trailer. This is set by a fleet administrator and will appear in both Samsaras cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.
          example: Trailer-123
          type: string
        tags:
          description: The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Trailer.
          items:
            $ref: '#/components/schemas/GoaTagTinyResponseResponseBody'
          type: array
        trailerSerialNumber:
          description: The serial number of the trailer.
          example: 8V8WD530FLN016251
          type: string
      required:
      - id
      type: object
    WorkflowIncidentDetailsObjectResponseBody:
      description: Object representing the granular details of the condition. These details will vary depending on the condition.
      properties:
        ambientTemperature:
          $ref: '#/components/schemas/AmbientTemperatureResponseBody'
        cameraConnectorDisconected:
          $ref: '#/components/schemas/CameraConnectorDisconectedResponseBody'
        cameraStreamIssue:
          $ref: '#/components/schemas/CameraStreamIssueResponseBody'
        cellSignalLoss:
          $ref: '#/components/schemas/CellSignalLossResponseBody'
        cloudBackupUploadIssue:
          $ref: '#/components/schemas/CloudBackupUploadIssueResponseBody'
        dashcamDisconnected:
          $ref: '#/components/schemas/DashcamDisconnectedResponseBody'
        dataInputValue:
          $ref: '#/components/schemas/DataInputValueResponseBody'
        deviceMovement:
          $ref: '#/components/schemas/DeviceMovementDataResponseBody'
        deviceMovementStopped:
          $ref: '#/components/schemas/DeviceMovementStoppedDataResponseBody'
        driverAppSignIn:
          $ref: '#/components/schemas/DriverAppSignInResponseBody'
        driverAppSignOut:
          $ref: '#/components/schemas/DriverAppSignOutResponseBody'
        driverDocumentSubmitted:
          $ref: '#/components/schemas/DriverDocumentSubmittedResponseBody'
        driverMessageReceived:
          $ref: '#/components/schemas/DriverMessageReceivedResponseBody'
        driverMessageSent:
          $ref: '#/components/schemas/DriverMessageSentResponseBody'
        driverRecorded:
          $ref: '#/components/schemas/DriverRecordedResponseBody'
        dvirSubmittedDevice:
          $ref: '#/components/schemas/WorkflowDvirSubmittedResponseObjectResponseBody'
        engineIdle:
          $ref: '#/components/schemas/EngineIdleDataResponseBody'
        engineOff:
          $ref: '#/components/schemas/EngineOffResponseBody'
        engineOn:
          $ref: '#/components/schemas/EngineOnResponseBody'
        formSubmitted:
          $ref: '#/components/schemas/FormSubmittedResponseBody'
        fuelLevelPercentage:
          $ref: '#/components/schemas/FuelLevelPercentageResponseBody'
        gatewayDisconnected:
          $ref: '#/components/schemas/GatewayDisconnectedResponseBody'
        gatewayUnplugged:
          $ref: '#/components/schemas/GatewayWithVehicleTinyResponseResponseBody'
        geofenceEntry:
          $ref: '#/components/schemas/WorkflowGeofenceEventResponseObjectResponseBody'
        geofenceExit:
          $ref: '#/components/schemas/WorkflowGeofenceEventResponseObjectResponseBody'
        gpsSignalLoss:
          $ref: '#/components/schemas/GpsSignalLossResponseBody'
        harshEvent:
          $ref: '#/components/schemas/HarshEventDataResponseBody'
        hosViolation:
          $ref: '#/components/schemas/HosViolationDataResponseBody'
        inactivity:
          $ref: '#/components/schemas/InactivityResponseBody'
        insideGeofence:
          $ref: '#/components/schemas/InsideGeofenceDataResponseBody'
        issueCreated:
          $ref: '#/components/schemas/IssueCreatedResponseBody'
        jammingDetected:
          $ref: '#/components/schemas/JammingDetectedResponseBody'
        motionDetected:
          $ref: '#/components/schemas/MotionDetectedResponseBody'
        outOfRoute:
          $ref: '#/components/schemas/OutOfRouteResponseBody'
        outsideGeofence:
          $ref: '#/components/schemas/OutsideGeofenceDataResponseBody'
        panicButton:
          $ref: '#/components/schemas/PanicButtonResponseBody'
        personDetected:
          $ref: '#/components/schemas/PersonDetectedResponseBody'
        reeferTemperature:
          $ref: '#/components/schemas/ReeferTemperatureResponseBody'
        routeStopArrival:
          $ref: '#/components/schemas/RouteStopDetailsObjectResponseBody'
        routeStopDeparture:
          $ref: '#/components/schemas/RouteStopDetailsObjectResponseBody'
        routeStopETA:
          $ref: '#/components/schemas/RouteStopETAResponseBody'
        scheduledMaintenance:
          $ref: '#/components/schemas/ScheduledMaintenanceDataResponseBody'
        scheduledMaintenanceByEngineHours:
          $ref: '#/components/schemas/ScheduledMaintenanceByEngineHoursResponseBody'
        scheduledMaintenanceOdometer:
          $ref: '#/components/schemas/ScheduledMaintenanceOdometerDataResponseBody'
        severeSpeeding:
          $ref: '#/components/schemas/SevereSpeedingStartedResponseObjectResponseBody'
        siteGatewayDisconnected:
          $ref: '#/components/schemas/SiteGatewayDisconnectedResponseBody'
        speed:
          $ref: '#/components/schemas/SpeedDataResponseBody'
        tamperingDetected:
          $ref: '#/components/schemas/TamperingDetectedResponseBody'
        tireFaults:
          $ref: '#/components/schemas/TireFaultsResponseBody'
        unassignedDriving:
          $ref: '#/components/schemas/UnassignedDrivingDataResponseBody'
        vehicleBatteryVoltage:
          $ref: '#/components/schemas/VehicleBatteryVoltageResponseBody'
        vehicleDefLevelPercentage:
          $ref: '#/components/schemas/VehicleDefLevelPercentageResponseBody'
        vehicleDetected:
          $ref: '#/components/schemas/VehicleDetectedResponseBody'
        vehicleFaults:
          $ref: '#/components/schemas/VehicleFaultsResponseBody'
      type: object
    WorkflowIncidentConditionObjectResponseBody:
      description: Object representing the granular details of the condition. These details will vary depending on the condition.
      properties:
        description:
          description: Descriptive name of the condition.
          example: Alert Type Description
          type: string
        details:
          $ref: '#/components/schemas/WorkflowIncidentDetailsObjectResponseBody'
        triggerId:
          description: Unique identifier describing the type of condition being represented.
          example: 1000
          format: int64
          type: integer
      required:
      - description
      - details
      - triggerId
      type: object
    AlertsGetIncidentsMethodNotAllowedErrorResponseBody:
      description: Method not allowed
      properties:
        message:
          description: Message of error
          example: DELETE not allowed on /endpoint.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    AlertsGetIncidentsTooManyRequestsErrorResponseBody:
      description: Too many requests
      properties:
        message:
          description: Message of error
          example: Exceeded rate limit.
          type: string
        requestId:
          description: The request ID; used when reaching out to support for issues with requests.
          example: 8916e1c1
          type: string
      required:
      - message
      - requestId
      type: object
    GatewayWithVehicleTinyResponseResponseBody:
      properties:
        model:
          description: 'The model of the gateway installed on the asset.  Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`'
          enum:
          - AG15
          - AG24
          - AG24EU
          - AG26
          - AG26EU
          - AG41
          - AG41EU
          - AG45
          - AG45EU
          - AG46
          - AG46EU
          - AG46P
          - AG46PEU
          - AG51
          - AG51EU
          - AG52
          - AG52EU
          - AG53
          - AG53EU
          - IG15
          - IG21
          - IG41
          - IG61
          - SG1
          - SG1B
          - SG1G
          - SG1G32
          - SG1x
          - VG32
          - VG33
          - VG34
          - VG34EU
          - VG34FN
          - VG34M
          - VG54ATT
          - VG54EU
          - VG54FN
          - VG54NA
          - VG54NAE
          - VG54NAH
          - VG55EU
          - VG55FN
          - VG55NA
          example: VG34
          type: string
        serial:
          description: The serial number of the gateway installed on the asset.
          example: GFRV-43N-VGX
          type: string
        vehicle:
          $ref: '#/components/schemas/GoaVehicleTinyResponseResponseBody'
      required:
      - model
      - serial
      type: object
    FormsMediaRecordObjectResponseBody:
      description: Forms media record object.
      properties:
        id:
          description: ID of the media record.
          example: 9814a1fa-f0c6-408b-bf85-51dc3bc71ac7
          format: uuid
          type: string
        processingStatus:
          description: 'Status of the media record.  Valid values: `unknown`, `processing`, `finished`'
          enum:
          - unknown
          - processing
          - finished
          example: processing
          type: string
        url:
          description: URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.
          example: https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456
          format: uri
          type: string
        urlExpiresAt:
          description: Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.
          example: '2019-06-13T19:08:25Z'
          format: date-time
          type: string
      required:
      - id
      - processingStatus
      type: object
    fieldObjectValueResponseBody:
      description: The value of the document field. The shape of value depends on the type.
      properties:
        barcodeValue:
          description: The value of a barcode scanning field. Only present for barcode scanning fields.
          items:
            $ref: '#/components/schemas/barcodeValueObjectResponseBody'
          type: array
        dateTimeValue:
          $ref: '#/components/schemas/dateTimeValueObjectResponseBody'
        multipleChoiceValue:
          description: The value of a multiple choice field. Only present for multiple choice fields.
          items:
            $ref: '#/components/schemas/multipleChoiceValueObjectResponseBody'
          type: array
        numberValue:
          description: The value of a number field. Only present for number fields.
          example: 123.456
          format: double
          type: number
        photoValue:
          description: The value of a photo field. Only present for photo fields.
          items:
            $ref: '#/components/schemas/photoValueObjectResponseBody'
          type: array
        scannedDocumentValue:
          description: The value of a scanned document field. Only present for scanned document fields.
          items:
            $ref: '#/components/schemas/scannedDocumentValueObjectResponseBody'
          type: array
        signatureValue:
          $ref: '#/components/schemas/signatureValueObjectResponseBody'
        stringValue:
          description: The value of a string field. Only present for string fields.
          example: Red Truck
          type: string
      type: object
    DriverAppSignInResponseBody:
      description: Details specific to Driver App Sign In.
      properties:
        driver:
          $ref: '#/components/schemas/alertObjectDriverResponseBody'
      type: object
    scannedDocumentValueObjectResponseBody:
      properties:
        id:
          description: Id of the scanned document.
          example: f5271458-21f9-4a9f-a290-780c6d8840ff
          type: string
        url:
          description: Url of the scanned document.
          example: https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456
          type: string
      type: object
    WorkflowDvirObjectResponseBody:
      description: A DVIR description
      properties:
        authorSignature:
          $ref: '#/components/schemas/WorkflowAuthorSignatureObjectResponseBody'
        defects:
          description: Defects registered for the DVIR.
          items:
            $ref: '#/components/schemas/DvirDefectsObject_v2022_09_13ResponseBody'
          type: array
        endTime:
          description: Time when the driver signed and completed this DVIR. UTC timestamp in RFC 3339 format.
          example: '2020-01-27T07:06:25Z'
          type: string
        formattedLocation:
          description: Optional string if your jurisdiction requires a location of the DVIR.
          example: 350 Rhode Island St Ste. 400S, San Francisco, CA 94103
          type: string
        id:
          description: The unique id of the DVIR
          example: '12345'
          type: string
        mechanicNotes:
          description: The mechanics notes on the DVIR.
          example: Replaced headlight on passenger side.
          type: string
        needsCorrection:
          description: Indicates if a defect needs correction.
          example: false
          type: boolean
        odometerMeters:
          description: The odometer reading in meters.
          example: 91823
          format: int64
          type: integer
        safetyStatus:
          description: 'The condition of vehicle on which DVIR was done.  Valid values: `safe`, `unsafe`, `resolved`'
          enum:
          - safe
          - unsafe
          - resolved
          example: unsafe
          type: string
        secondSignature:
          $ref: '#/components/schemas/WorkflowAuthorSignatureObjectResponseBody'
        startTime:
          description: Time when driver began filling out this DVIR in RFC 3339 format.
          example: '2020-01-27T07:06:25Z'
          type: string
        thirdSignature:
          $ref: '#/components/schemas/WorkflowAuthorSignatureObjectResponseBody'
        trailer:
          $ref: '#/components/schemas/GoaTrailerTinyResponseResponseBody'
        type:
          description: 'Inspection type of the DVIR.  Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`'
          enum:
          - preTrip
          - postTrip
          - mechanic
          - unspecified
          example: mechanic
          type: string
      required:
      - authorSignature
      - endTime
      - id
      - needsCorrection
      - safetyStatus
      - startTime
      - type
      type: object
    FormsIssueCreatedByFieldObjectResponseBody:
      description: Issue created from this form input field input object.
      properties:
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        id:
          description: ID of the issue created from this form input field input object.
          example: '12345'
          type: string
      required:
      - id
      type: object
    EngineOffResponseBody:
      description: Details specific to Engine Off.
      properties:
        driver:
          $ref: '#/components/schemas/alertObjectDriverResponseBody'
        trailer:
          $ref: '#/components/schemas/alertObjectTrailerResponseBody'
        vehicle:
          $ref: '#/components/schemas/alertObjectVehicleResponseBody'
      type: object
    MinimalRouteStopResponseBody:
      description: A single route stop for a route.
      properties:
        actualArrivalTime:
          description: Actual arrival time, if it exists, for the route stop in RFC 3339 format.
          example: '2006-01-02T15:04:05+07:00'
          format: date-time
          type: string
        actualDepartureTime:
          description: Actual departure time, if it exists, for the route stop in RFC 3339 format.
          example: '2006-01-02T15:04:05+07:00'
          format: date-time
          type: string
        enRouteTime:
          description: The time the stop became en-route, in RFC 3339 format.
          example: '2006-01-02T15:04:05+07:00'
          format: date-time
          type: string
        eta:
          description: Estimated time of arrival, if this stop is currently en-route, in RFC 3339 format.
          example: '2006-01-02T15:04:05+07:00'
          format: date-time
          type: string
        externalIds:
          additionalProperties:
            type: string
          description: A map of external ids
          type: object
        id:
          description: Unique identifier for the route stop.
          example: '141414'
          type: string
        liveSharingUrl:
          description: The shareable url of the stop's current status.
          example: https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token
          type: string
        skippedTime:
          description: Skipped time, if it exists, for the route stop in RFC 3339 format.
          example: '2006-01-02T15:04:05+07:00'
          format: date-time
          type: string
        state:
          description: 'The current state of the route stop.  Valid values: `unassigned`, `scheduled`, `en route`, `skipped`, `arrived`, `departed`'
          enum:
          - unassigned
          - scheduled
          - en route
          - skipped
          - arrived
          - departed
          example: scheduled
          type: string
      required:
      - id
      - state
      type: object
    multipleChoiceValueObjectResponseBody:
      properties:
        selected:
          description: Boolean representing if the choice has been selected.
          example: false
          type: boolean
        value:
          description: Description of the choice.
          example: 'Yes'
          type: string
      type: object
    SettingsResponseBody:
      description: Information about a geofence settings.
      properties:
        showAddresses:
          description: The geofence setting. If this setting set to true, then underlying geofence addresses will be shown in reports instead of a geofence's name.
          items:
            $ref: '#/components/schemas/VertexResponseBody'
          type: array
      type: object
    GoaPaginationResponseResponseBody:
      description: Pagination parameters.
      properties:
        endCursor:
          description: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
          example: MjkY
          type: string
        hasNextPage:
          description: True if there are more pages of results immediately available after this endCursor.
          example: true
          type: boolean
      required:
      - endCursor
      - hasNextPage
      type: object
    ScheduledMaintenanceByEngineHoursResponseBody:
      description: Details specific to Scheduled Maintenance By Engine Hours.
      properties:
        driver:
          $ref: '#/components/schemas/alertObjectDriverResponseBody'
        trailer:
          $ref: '#/components/schemas/alertObjectTrailerResponseBody'
        vehicle:
          $ref: '#/components/schemas/alertObjectVehicleResponseBody'
      type: object
    ReeferTemperatureResponseBody:
      description: Details specific to Reefer Temperature.
      properties:
        driver:
          $ref: '#/components/schemas/alertObjectDriverResponseBody'
        trailer:
          $ref: '#/components/schemas/alertObjectTrailerResponseBody'
        vehicle:
          $ref: '#/components/schemas/alertObjectVehicleResponseBody'
      type: object
    documentResponseObjectResponseBody:
      description: A single document.
      properties:
        conditionalFieldSections:
          description: List of the document conditional field sections.
          items:
            $ref: '#/components/schemas/conditionalFieldSectionObjectResponseBody'
          type: array
        createdAtTime:
          description: Time the document was created in RFC 3339 format.
          example: '1971-05-04T11:43:21Z'
          format: date-time
          type: string
        documentType:
          $ref: '#/components/sche

# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/samsara/refs/heads/main/openapi/samsara-incidents-api-openapi.yml