Welcome to the TenTrucks ELD GraphQL API

Thank you for building on TenTrucks ELD, the FMCSA-compliant platform that powers fleets of every size. Our GraphQL API lets you work programmatically with vehicles, drivers, logs, documents, inspections, notifications, and more—all from a single endpoint.

Use the navigation on the left for complete query & mutation docs, or jump straight into the intro sections below.

Contact

API Support

support@tentrucks.com

https://www.tentrucks.com/contact-us

Terms of Service

https://www.tentrucks.com/terms-and-conditions

API Endpoints
# Production:
https://core.tentrucks.com/graphql
Headers
# Your API access key ID from the TenTrucks developer portal
X-API-Key: TTabcdef1234567890
# Your API secret key (shown once at creation time)
X-API-Secret: <YOUR_API_SECRET>

Quick Start

# Use your API Key and Secret from the TenTrucks developer portal
curl -X POST \
     -H "Content-Type: application/json" \
     -H "X-API-Key: TTabcdef1234567890" \
     -H "X-API-Secret: <YOUR_API_SECRET>" \
     -d '{"query":"{ vehicles { items { id name vin } } }"}' \
     https://core.tentrucks.com/graphql

A successful response returns your fleet data—proof that your API key works.

Core Concepts

Concept What it does Common examples
Queries Read-only operations vehicles, drivers, logs
Mutations Create / update / delete createDriver, updateVehicle
Pagination Cursor-based lists vehicles(query: { pagination: { page: 1, size: 50 } })
Filtering Rich filters on list endpoints logs(query: { filters: { date: "2025-07-22" } })
File Uploads Pre-signed S3 URLs generateFileUploadUrl

Authentication

All requests require an API Key and API Secret sent as HTTP headers:

Header Description
X-API-Key Your access key ID (starts with TT)
X-API-Secret Your secret key (shown once at creation time)
  • Generate keys in the TenTrucks web portal under Admin > Developer
  • Each API key has scoped permissions—it can only access endpoints its role permits
  • All traffic over TLS 1.2+

Time Zones & Dates

  • All timestamps are UTC ISO-8601 (2025-07-22T08:15:30Z).
  • Many queries accept a timezone argument; daylight-saving shifts handled automatically.

Error Handling

The API returns errors in the standard GraphQL errors array. Each error type has a specific shape:

Every error includes extensions.code for programmatic handling and extensions.traceId for support requests.

Check code first — it tells you what went wrong. Then look at other extension fields for details.

VALIDATION_ERROR — input failed validation. One error per field:

{
  "errors": [
    {
      "message": "First name is required.",
      "extensions": { "code": "VALIDATION_ERROR", "field": "firstName", "traceId": "a1b2c3d4e5f6" }
    },
    {
      "message": "VIN must be 17 characters.",
      "extensions": { "code": "VALIDATION_ERROR", "field": "vin", "traceId": "a1b2c3d4e5f6" }
    }
  ]
}

ENTITY_NOT_FOUND — the requested resource does not exist:

{
  "errors": [
    {
      "message": "Driver not found.",
      "extensions": { "code": "ENTITY_NOT_FOUND", "traceId": "a1b2c3d4e5f6" }
    }
  ]
}

FORBIDDEN — your API key does not have the required permission:

{
  "errors": [
    {
      "message": "You don't have enough permission to perform this action.",
      "extensions": { "code": "FORBIDDEN", "traceId": "a1b2c3d4e5f6" }
    }
  ]
}

UNAUTHENTICATED — invalid or missing API key/secret:

{
  "errors": [
    {
      "message": "Invalid API key.",
      "extensions": { "code": "UNAUTHENTICATED", "traceId": "a1b2c3d4e5f6" }
    }
  ]
}

INTERNAL_ERROR — unexpected server error (include traceId when contacting support):

{
  "errors": [
    {
      "message": "An unexpected error occurred. Please try again or contact support.",
      "extensions": { "code": "INTERNAL_ERROR", "traceId": "a1b2c3d4e5f6" }
    }
  ]
}
extensions.code extensions.field Description
VALIDATION_ERROR field name Input value is invalid or missing
ENTITY_NOT_FOUND — Resource with given ID does not exist
FORBIDDEN — API key lacks required permission for this endpoint
UNAUTHENTICATED — Missing, invalid, or expired API key/secret
INTERNAL_ERROR — Unexpected server error — include traceId in support requests

Rate Limits

Changelog

Date Version Notes
2025-07-22 v1.0 Initial public release

Queries

asset

Description

Fetch a single Asset by its ID.

Always expands groups and inspectionForm relationships so UIs can render asset tags and default DVIR templates without a secondary round-trip.

Response

Returns an AssetResponse!

Arguments
Name Description
query - AssetQuery! Query input containing the Asset ID (e.g. ast_abc123).

Example

Query
query Asset($query: AssetQuery!) {
  asset(query: $query) {
    length {
      value
      unit {
        ...IdNameResponseFragment
      }
    }
    groups {
      name
      id
    }
    notes
    updatedBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    gvwr {
      value
      unit {
        ...IdNameResponseFragment
      }
    }
    gawr {
      value
      unit {
        ...IdNameResponseFragment
      }
    }
    license {
      state
      number
    }
    ownership {
      name
      id
    }
    axles
    manualLocation {
      location
      latitude
      longitude
    }
    calculatedLocation {
      location
      latitude
      longitude
    }
    inspectionForm {
      name
      id
    }
    currentDriver {
      id
      username
      firstName
      lastName
      driverId
    }
    currentVehicle {
      id
      number
      year
      vin
      model
      make
    }
    id
    type {
      name
      id
    }
    number
    year
    vin
    status {
      name
      id
    }
    createdAt
    updatedAt
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    model
    make
  }
}
Variables
{"query": AssetQuery}
Response
{
  "data": {
    "asset": {
      "length": AssetLengthResponse,
      "groups": [ShortGroupResponse],
      "notes": "abc123",
      "updatedBy": ShortEmployeeResponse,
      "gvwr": GrossWeightResponse,
      "gawr": GrossWeightResponse,
      "license": LicenseResponse,
      "ownership": IdNameResponse,
      "axles": 123,
      "manualLocation": LocationResponse,
      "calculatedLocation": LocationResponse,
      "inspectionForm": ShortInspectionFormResponse,
      "currentDriver": EmbeddedDriverResponse,
      "currentVehicle": EmbeddedVehicleResponse,
      "id": "xyz789",
      "type": IdNameResponse,
      "number": "abc123",
      "year": 987,
      "vin": "abc123",
      "status": IdNameResponse,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "createdBy": ShortEmployeeResponse,
      "model": "abc123",
      "make": "abc123"
    }
  }
}
Queries

assets

Description

Fetches a paginated list of assets—with search, filters, and sorting—for the assets query.

Response

Returns a PaginatedAssetsResponse!

Arguments
Name Description
query - AssetsQuery Optional query object with filters, pagination, and sort options.

Example

Query
query Assets($query: AssetsQuery) {
  assets(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    assets {
      groups {
        ...ShortGroupResponseFragment
      }
      updatedBy {
        ...ShortEmployeeWithPhotoResponseFragment
      }
      license {
        ...LicenseResponseFragment
      }
      manualLocation {
        ...LocationResponseFragment
      }
      calculatedLocation {
        ...LocationResponseFragment
      }
      inspectionForm {
        ...ShortInspectionFormResponseFragment
      }
      currentDriver {
        ...EmbeddedDriverResponseFragment
      }
      currentVehicle {
        ...EmbeddedVehicleResponseFragment
      }
      id
      type {
        ...IdNameResponseFragment
      }
      number
      year
      vin
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      model
      make
    }
  }
}
Variables
{"query": AssetsQuery}
Response
{
  "data": {
    "assets": {
      "pagination": PaginationResponse,
      "assets": [ListedAssetResponse]
    }
  }
}
Queries

company

Description

Fetches the authenticated company profile for the company query.

Response

Returns a CompanyResponse!

Example

Query
query Company {
  company {
    name
    id
    address {
      state
      street
      city
      zipCode
    }
    currency {
      name
      id
      symbol
    }
    dotNumber
    volumeUnit {
      name
      id
    }
    timezone {
      name
      id
      code
    }
    logSettings {
      restBreak {
        ...IdNameResponseFragment
      }
      odometer {
        ...IdNameResponseFragment
      }
      cargoType {
        ...IdNameResponseFragment
      }
      restart {
        ...IdNameResponseFragment
      }
      wellSite {
        ...IdNameResponseFragment
      }
      yardMove {
        ...IdNameResponseFragment
      }
      secondCycle {
        ...IdNameResponseFragment
      }
      cycle {
        ...IdNameResponseFragment
      }
      secondRestBreak {
        ...IdNameResponseFragment
      }
      shortHaulException {
        ...IdNameResponseFragment
      }
      weeklyHourLimit {
        ...IdNameResponseFragment
      }
      cdlDriverType {
        ...IdNameResponseFragment
      }
      logIncrement {
        ...IdNameResponseFragment
      }
      personalConveyance {
        ...IdNameResponseFragment
      }
      secondCargoType {
        ...IdNameResponseFragment
      }
      secondRestart {
        ...IdNameResponseFragment
      }
      secondCdlDriverType {
        ...IdNameResponseFragment
      }
      secondWellSite {
        ...IdNameResponseFragment
      }
      adverseConditionsException {
        ...IdNameResponseFragment
      }
      secondShortHaulException {
        ...IdNameResponseFragment
      }
      secondWeeklyHourLimit {
        ...IdNameResponseFragment
      }
      secondAdverseConditionsException {
        ...IdNameResponseFragment
      }
    }
  }
}
Response
{
  "data": {
    "company": {
      "name": "xyz789",
      "id": "xyz789",
      "address": AddressResponse,
      "currency": CurrencyResponse,
      "dotNumber": "abc123",
      "volumeUnit": IdNameResponse,
      "timezone": TimezoneResponse,
      "logSettings": LogSettingsResponse
    }
  }
}
Queries

constants

Description

Fetches the master list of constants for the constants query.

Response

Returns a ConstantsResponse!

Example

Query
query Constants {
  constants {
    eventTypes {
      description
      name
      id
      isDuty
    }
    permissions {
      name
      id
    }
    alertTypes {
      name
      id
      subjects {
        ...IdNameResponseFragment
      }
      title
    }
    themes {
      name
      id
    }
    currencies {
      name
      id
      symbol
    }
    fuelVolumes {
      name
      id
    }
    yesNo {
      name
      id
    }
    lengthUnit {
      name
      id
    }
    massUnit {
      name
      id
    }
    notesPolicy {
      name
      id
    }
    cycleRules {
      name
      id
      isCargoTypeRequired
      isRestartRequired
      isRestBreakRequired
      isWellSiteRequired
      isWeeklyHourLimitRequired
      isCdlDriverTypeRequired
      isShortHaulExceptionRequired
      isAdverseConditionsExceptionRequired
    }
    timezones {
      name
      id
    }
    cargoTypes {
      name
      id
    }
    restarts {
      name
      id
    }
    restBreaks {
      name
      id
    }
    wellSites {
      name
      id
    }
    yardMoves {
      name
      id
    }
    fuelTypes {
      name
      id
    }
    assetTypes {
      name
      id
    }
    eventModes {
      name
      id
    }
    languages {
      name
      id
    }
    odometer {
      name
      id
    }
    states {
      name
      id
    }
    ownership {
      name
      id
    }
    roleStatuses {
      name
      id
    }
    groupStatuses {
      name
      id
    }
    vehicleStatuses {
      name
      id
    }
    assetStatuses {
      name
      id
    }
    employeeStatuses {
      name
      id
    }
    driverStatuses {
      name
      id
    }
    photoEvidencePolicy {
      name
      id
    }
    locationPolicy {
      name
      id
    }
    odometerPolicy {
      name
      id
    }
    shortHaulExceptions {
      name
      id
    }
    weeklyHourLimits {
      name
      id
    }
    cdlDriverTypes {
      name
      id
    }
    personalConveyances {
      name
      id
    }
    logIncrements {
      name
      id
    }
    customFieldTypes {
      name
      id
    }
    vehicleMakes {
      name
      id
    }
    liveStatuses {
      name
      id
    }
    liveEntities {
      name
      id
    }
    maintenanceStatuses {
      name
      id
    }
    maintenanceTypes {
      name
      id
    }
    maintenanceEntities {
      name
      id
    }
    documentDateTypes {
      name
      id
    }
    eventOrigins {
      name
      id
    }
    eventStatuses {
      name
      id
    }
    logCombinedStatuses {
      name
      id
    }
    alertTargetTypes {
      name
      id
    }
    alertPriorities {
      name
      id
    }
    alertMethods {
      name
      id
    }
    employeeNumbers {
      name
      id
    }
    eldDeviceModels {
      name
      id
    }
    inspectAllPartsPolicy {
      name
      id
    }
    adverseConditionsExceptions {
      name
      id
    }
    maintenanceCombinedStatuses {
      name
      id
    }
    documentTypeStatuses {
      name
      id
    }
    documentTypeAccesses {
      name
      id
    }
    documentTypeAutoExtract {
      name
      id
    }
    customFieldDateVisibility {
      name
      id
    }
    customFieldNotesVisibility {
      name
      id
    }
    customFieldAssetVisibility {
      name
      id
    }
    customFieldDriverVisibility {
      name
      id
    }
    alertVehicleActivities {
      name
      id
    }
    inspectedPartStatuses {
      name
      id
    }
    inspectionFormTargets {
      name
      id
    }
    eldDeviceCombinedStatuses {
      name
      id
    }
    driverSignatureDeclaration
    alertBeforeViolation {
      name
      id
    }
    inspectPreviousMissingDaysPolicy {
      name
      id
    }
    documentTypeCustomFieldNames {
      name
      id
    }
    customFieldReferenceIdVisibility {
      name
      id
    }
    customFieldFuelEntryVisibility {
      name
      id
    }
    customFieldJurisdictionVisibility {
      name
      id
    }
    customFieldFuelTypeVisibility {
      name
      id
    }
    customFieldFuelVolumeVisibility {
      name
      id
    }
    customFieldTotalCostVisibility {
      name
      id
    }
    customFieldVendorNameVisibility {
      name
      id
    }
    customFieldLocationVisibility {
      name
      id
    }
    customFieldOdometerVisibility {
      name
      id
    }
    customFieldVehicleVisibility {
      name
      id
    }
    customFieldDriverLicenseVisibility {
      name
      id
    }
    customFieldExpirationDateVisibility {
      name
      id
    }
    customFieldInvoiceNumberVisibility {
      name
      id
    }
    customFieldLoadNumberVisibility {
      name
      id
    }
    customFieldPaymentMethodVisibility {
      name
      id
    }
    customFieldCurrencyVisibility {
      name
      id
    }
    customFieldTollLocationVisibility {
      name
      id
    }
    resolvableInspectedPartStatuses {
      name
      id
    }
  }
}
Response
{
  "data": {
    "constants": {
      "eventTypes": [LogEventTypeResponse],
      "permissions": [IdNameResponse],
      "alertTypes": [AlertTypeResponse],
      "themes": [IdNameResponse],
      "currencies": [CurrencyResponse],
      "fuelVolumes": [IdNameResponse],
      "yesNo": [IdNameResponse],
      "lengthUnit": [IdNameResponse],
      "massUnit": [IdNameResponse],
      "notesPolicy": [IdNameResponse],
      "cycleRules": [CycleRuleResponse],
      "timezones": [IdNameResponse],
      "cargoTypes": [IdNameResponse],
      "restarts": [IdNameResponse],
      "restBreaks": [IdNameResponse],
      "wellSites": [IdNameResponse],
      "yardMoves": [IdNameResponse],
      "fuelTypes": [IdNameResponse],
      "assetTypes": [IdNameResponse],
      "eventModes": [IdNameResponse],
      "languages": [IdNameResponse],
      "odometer": [IdNameResponse],
      "states": [IdNameResponse],
      "ownership": [IdNameResponse],
      "roleStatuses": [IdNameResponse],
      "groupStatuses": [IdNameResponse],
      "vehicleStatuses": [IdNameResponse],
      "assetStatuses": [IdNameResponse],
      "employeeStatuses": [IdNameResponse],
      "driverStatuses": [IdNameResponse],
      "photoEvidencePolicy": [IdNameResponse],
      "locationPolicy": [IdNameResponse],
      "odometerPolicy": [IdNameResponse],
      "shortHaulExceptions": [IdNameResponse],
      "weeklyHourLimits": [IdNameResponse],
      "cdlDriverTypes": [IdNameResponse],
      "personalConveyances": [IdNameResponse],
      "logIncrements": [IdNameResponse],
      "customFieldTypes": [IdNameResponse],
      "vehicleMakes": [IdNameResponse],
      "liveStatuses": [IdNameResponse],
      "liveEntities": [IdNameResponse],
      "maintenanceStatuses": [IdNameResponse],
      "maintenanceTypes": [IdNameResponse],
      "maintenanceEntities": [IdNameResponse],
      "documentDateTypes": [IdNameResponse],
      "eventOrigins": [IdNameResponse],
      "eventStatuses": [IdNameResponse],
      "logCombinedStatuses": [IdNameResponse],
      "alertTargetTypes": [IdNameResponse],
      "alertPriorities": [IdNameResponse],
      "alertMethods": [IdNameResponse],
      "employeeNumbers": [IdNameResponse],
      "eldDeviceModels": [IdNameResponse],
      "inspectAllPartsPolicy": [IdNameResponse],
      "adverseConditionsExceptions": [IdNameResponse],
      "maintenanceCombinedStatuses": [IdNameResponse],
      "documentTypeStatuses": [IdNameResponse],
      "documentTypeAccesses": [IdNameResponse],
      "documentTypeAutoExtract": [IdNameResponse],
      "customFieldDateVisibility": [IdNameResponse],
      "customFieldNotesVisibility": [IdNameResponse],
      "customFieldAssetVisibility": [IdNameResponse],
      "customFieldDriverVisibility": [IdNameResponse],
      "alertVehicleActivities": [IdNameResponse],
      "inspectedPartStatuses": [IdNameResponse],
      "inspectionFormTargets": [IdNameResponse],
      "eldDeviceCombinedStatuses": [IdNameResponse],
      "driverSignatureDeclaration": "abc123",
      "alertBeforeViolation": [IdNameResponse],
      "inspectPreviousMissingDaysPolicy": [
        IdNameResponse
      ],
      "documentTypeCustomFieldNames": [IdNameResponse],
      "customFieldReferenceIdVisibility": [
        IdNameResponse
      ],
      "customFieldFuelEntryVisibility": [IdNameResponse],
      "customFieldJurisdictionVisibility": [
        IdNameResponse
      ],
      "customFieldFuelTypeVisibility": [IdNameResponse],
      "customFieldFuelVolumeVisibility": [IdNameResponse],
      "customFieldTotalCostVisibility": [IdNameResponse],
      "customFieldVendorNameVisibility": [IdNameResponse],
      "customFieldLocationVisibility": [IdNameResponse],
      "customFieldOdometerVisibility": [IdNameResponse],
      "customFieldVehicleVisibility": [IdNameResponse],
      "customFieldDriverLicenseVisibility": [
        IdNameResponse
      ],
      "customFieldExpirationDateVisibility": [
        IdNameResponse
      ],
      "customFieldInvoiceNumberVisibility": [
        IdNameResponse
      ],
      "customFieldLoadNumberVisibility": [IdNameResponse],
      "customFieldPaymentMethodVisibility": [
        IdNameResponse
      ],
      "customFieldCurrencyVisibility": [IdNameResponse],
      "customFieldTollLocationVisibility": [
        IdNameResponse
      ],
      "resolvableInspectedPartStatuses": [IdNameResponse]
    }
  }
}
Queries

document

Response

Returns a DocumentResponse!

Arguments
Name Description
query - DocumentQuery!

Example

Query
query Document($query: DocumentQuery!) {
  document(query: $query) {
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    updatedBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    attachments {
      name
      id
      type {
        ...IdNameResponseFragment
      }
      size
      url
      createdAt
      updatedAt
    }
    sharedDrivers {
      id
      status {
        ...IdNameResponseFragment
      }
      username
      firstName
      lastName
      driverId
    }
    sharedGroups {
      name
      id
    }
    entities {
      vehicle {
        ...EmbeddedVehicleResponseFragment
      }
      asset {
        ...EmbeddedAssetResponseFragment
      }
      driver {
        ...EmbeddedDriverResponseFragment
      }
    }
    name
    id
    type {
      name
      id
    }
    number
    date
    referenceId
    notes
    status {
      name
      id
    }
    createdAt
    updatedAt
  }
}
Variables
{"query": DocumentQuery}
Response
{
  "data": {
    "document": {
      "createdBy": ShortEmployeeResponse,
      "updatedBy": ShortEmployeeResponse,
      "attachments": [AttachmentResponse],
      "sharedDrivers": [ShortDriverResponse],
      "sharedGroups": [ShortGroupResponse],
      "entities": DocumentEntitiesResponse,
      "name": "xyz789",
      "id": "xyz789",
      "type": IdNameResponse,
      "number": 987,
      "date": "xyz789",
      "referenceId": "abc123",
      "notes": "abc123",
      "status": IdNameResponse,
      "createdAt": "abc123",
      "updatedAt": "xyz789"
    }
  }
}
Queries

documentType

Response

Returns a DocumentTypeResponse!

Arguments
Name Description
query - DocumentTypeQuery!

Example

Query
query DocumentType($query: DocumentTypeQuery!) {
  documentType(query: $query) {
    name
    id
    access {
      name
      id
    }
    status {
      name
      id
    }
    createdAt
    updatedAt
    isSystem
    customFields {
      location {
        ...DocumentTypeCustomFieldResponseFragment
      }
      currency {
        ...DocumentTypeCustomFieldResponseFragment
      }
      date {
        ...DocumentTypeCustomFieldDocumentDateResponseFragment
      }
      fuelEntry {
        ...DocumentTypeCustomFieldFuelEntryResponseFragment
      }
      referenceId {
        ...DocumentTypeCustomFieldResponseFragment
      }
      notes {
        ...DocumentTypeCustomFieldResponseFragment
      }
      fuelType {
        ...DocumentTypeCustomFieldResponseFragment
      }
      fuelVolume {
        ...DocumentTypeCustomFieldResponseFragment
      }
      totalCost {
        ...DocumentTypeCustomFieldResponseFragment
      }
      vendorName {
        ...DocumentTypeCustomFieldResponseFragment
      }
      odometer {
        ...DocumentTypeCustomFieldResponseFragment
      }
      loadNumber {
        ...DocumentTypeCustomFieldResponseFragment
      }
      vehicle {
        ...DocumentTypeCustomFieldResponseFragment
      }
      asset {
        ...DocumentTypeCustomFieldResponseFragment
      }
      driver {
        ...DocumentTypeCustomFieldResponseFragment
      }
      jurisdiction {
        ...DocumentTypeCustomFieldResponseFragment
      }
      driverLicense {
        ...DocumentTypeCustomFieldResponseFragment
      }
      expirationDate {
        ...DocumentTypeCustomFieldResponseFragment
      }
      invoiceNumber {
        ...DocumentTypeCustomFieldResponseFragment
      }
      paymentMethod {
        ...DocumentTypeCustomFieldResponseFragment
      }
      tollLocation {
        ...DocumentTypeCustomFieldResponseFragment
      }
    }
    supportFileTypes {
      name
      id
    }
  }
}
Variables
{"query": DocumentTypeQuery}
Response
{
  "data": {
    "documentType": {
      "name": "xyz789",
      "id": "abc123",
      "access": IdNameResponse,
      "status": IdNameResponse,
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "isSystem": false,
      "customFields": DocumentTypeCustomFieldsResponse,
      "supportFileTypes": [IdNameResponse]
    }
  }
}
Queries

documentTypes

Response

Returns [DocumentTypeResponse!]!

Arguments
Name Description
query - DocumentTypesQuery

Example

Query
query DocumentTypes($query: DocumentTypesQuery) {
  documentTypes(query: $query) {
    name
    id
    access {
      name
      id
    }
    status {
      name
      id
    }
    createdAt
    updatedAt
    isSystem
    customFields {
      location {
        ...DocumentTypeCustomFieldResponseFragment
      }
      currency {
        ...DocumentTypeCustomFieldResponseFragment
      }
      date {
        ...DocumentTypeCustomFieldDocumentDateResponseFragment
      }
      fuelEntry {
        ...DocumentTypeCustomFieldFuelEntryResponseFragment
      }
      referenceId {
        ...DocumentTypeCustomFieldResponseFragment
      }
      notes {
        ...DocumentTypeCustomFieldResponseFragment
      }
      fuelType {
        ...DocumentTypeCustomFieldResponseFragment
      }
      fuelVolume {
        ...DocumentTypeCustomFieldResponseFragment
      }
      totalCost {
        ...DocumentTypeCustomFieldResponseFragment
      }
      vendorName {
        ...DocumentTypeCustomFieldResponseFragment
      }
      odometer {
        ...DocumentTypeCustomFieldResponseFragment
      }
      loadNumber {
        ...DocumentTypeCustomFieldResponseFragment
      }
      vehicle {
        ...DocumentTypeCustomFieldResponseFragment
      }
      asset {
        ...DocumentTypeCustomFieldResponseFragment
      }
      driver {
        ...DocumentTypeCustomFieldResponseFragment
      }
      jurisdiction {
        ...DocumentTypeCustomFieldResponseFragment
      }
      driverLicense {
        ...DocumentTypeCustomFieldResponseFragment
      }
      expirationDate {
        ...DocumentTypeCustomFieldResponseFragment
      }
      invoiceNumber {
        ...DocumentTypeCustomFieldResponseFragment
      }
      paymentMethod {
        ...DocumentTypeCustomFieldResponseFragment
      }
      tollLocation {
        ...DocumentTypeCustomFieldResponseFragment
      }
    }
    supportFileTypes {
      name
      id
    }
  }
}
Variables
{"query": DocumentTypesQuery}
Response
{
  "data": {
    "documentTypes": [
      {
        "name": "xyz789",
        "id": "xyz789",
        "access": IdNameResponse,
        "status": IdNameResponse,
        "createdAt": "abc123",
        "updatedAt": "abc123",
        "isSystem": true,
        "customFields": DocumentTypeCustomFieldsResponse,
        "supportFileTypes": [IdNameResponse]
      }
    ]
  }
}
Queries

documents

Response

Returns a PaginatedDocumentsResponse!

Arguments
Name Description
query - DocumentsQuery

Example

Query
query Documents($query: DocumentsQuery) {
  documents(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    documents {
      createdBy {
        ...ShortEmployeeWithPhotoResponseFragment
      }
      updatedBy {
        ...ShortEmployeeWithPhotoResponseFragment
      }
      sharedDrivers {
        ...ShortDriverResponseFragment
      }
      sharedGroups {
        ...ShortGroupResponseFragment
      }
      entities {
        ...DocumentEntitiesResponseFragment
      }
      name
      id
      type {
        ...IdNameResponseFragment
      }
      number
      date
      referenceId
      notes
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
    }
  }
}
Variables
{"query": DocumentsQuery}
Response
{
  "data": {
    "documents": {
      "pagination": PaginationResponse,
      "documents": [ListedDocumentResponse]
    }
  }
}
Queries

downloadDriversOverview

Response

Returns a FileDownloadUrlResponse!

Arguments
Name Description
query - DownloadDriversOverviewQuery

Example

Query
query DownloadDriversOverview($query: DownloadDriversOverviewQuery) {
  downloadDriversOverview(query: $query) {
    url
  }
}
Variables
{"query": DownloadDriversOverviewQuery}
Response
{
  "data": {
    "downloadDriversOverview": {
      "url": "abc123"
    }
  }
}
Queries

downloadDriversWorkload

Response

Returns a FileDownloadUrlResponse!

Arguments
Name Description
query - DownloadDriversWorkloadQuery

Example

Query
query DownloadDriversWorkload($query: DownloadDriversWorkloadQuery) {
  downloadDriversWorkload(query: $query) {
    url
  }
}
Variables
{"query": DownloadDriversWorkloadQuery}
Response
{
  "data": {
    "downloadDriversWorkload": {
      "url": "xyz789"
    }
  }
}
Queries

downloadEmployeesOverview

Response

Returns a FileDownloadUrlResponse!

Arguments
Name Description
query - DownloadEmployeesOverviewQuery

Example

Query
query DownloadEmployeesOverview($query: DownloadEmployeesOverviewQuery) {
  downloadEmployeesOverview(query: $query) {
    url
  }
}
Variables
{"query": DownloadEmployeesOverviewQuery}
Response
{
  "data": {
    "downloadEmployeesOverview": {
      "url": "abc123"
    }
  }
}
Queries

driver

Response

Returns a DriverResponse!

Arguments
Name Description
query - DriverQuery!

Example

Query
query Driver($query: DriverQuery!) {
  driver(query: $query) {
    id
    hos {
      shift
      drive
      break
      cycle
      isCycleEnabled
      isShiftEnabled
      isBreakEnabled
      isDriveEnabled
    }
    appDevice {
      version
      isUpToDate
      platform {
        ...IdNameResponseFragment
      }
    }
    groups {
      name
      id
    }
    status {
      name
      id
    }
    username
    carrier {
      name
      address {
        ...AddressResponseFragment
      }
      dotNumber
    }
    createdAt
    updatedAt
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    photo
    email
    phone
    company {
      name
      id
    }
    timezone {
      name
      id
      code
    }
    firstName
    lastName
    driverId
    dutyStatus {
      name
      id
    }
    logSettings {
      restBreak {
        ...IdNameResponseFragment
      }
      odometer {
        ...IdNameResponseFragment
      }
      cargoType {
        ...IdNameResponseFragment
      }
      restart {
        ...IdNameResponseFragment
      }
      wellSite {
        ...IdNameResponseFragment
      }
      yardMove {
        ...IdNameResponseFragment
      }
      secondCycle {
        ...IdNameResponseFragment
      }
      cycle {
        ...IdNameResponseFragment
      }
      secondRestBreak {
        ...IdNameResponseFragment
      }
      shortHaulException {
        ...IdNameResponseFragment
      }
      weeklyHourLimit {
        ...IdNameResponseFragment
      }
      cdlDriverType {
        ...IdNameResponseFragment
      }
      logIncrement {
        ...IdNameResponseFragment
      }
      personalConveyance {
        ...IdNameResponseFragment
      }
      secondCargoType {
        ...IdNameResponseFragment
      }
      secondRestart {
        ...IdNameResponseFragment
      }
      secondCdlDriverType {
        ...IdNameResponseFragment
      }
      secondWellSite {
        ...IdNameResponseFragment
      }
      adverseConditionsException {
        ...IdNameResponseFragment
      }
      secondShortHaulException {
        ...IdNameResponseFragment
      }
      secondWeeklyHourLimit {
        ...IdNameResponseFragment
      }
      secondAdverseConditionsException {
        ...IdNameResponseFragment
      }
    }
    driverLicense {
      state
      number
    }
    dutyStatusSetAt
    lastAppSyncedAt
    lastActiveAt
    terminalAddress {
      state
      street
      city
      zipCode
    }
    manualLocation {
      location
      latitude
      longitude
    }
    calculatedLocation {
      location
      latitude
      longitude
    }
    currentAssets {
      id
      number
      year
      model
      make
    }
    currentVehicle {
      id
      number
      year
      vin
      model
      make
    }
    alertBeforeViolation {
      name
      id
    }
  }
}
Variables
{"query": DriverQuery}
Response
{
  "data": {
    "driver": {
      "id": "xyz789",
      "hos": HOSResponse,
      "appDevice": AppDeviceResponse,
      "groups": [ShortGroupResponse],
      "status": IdNameResponse,
      "username": "xyz789",
      "carrier": DriverCarrierResponse,
      "createdAt": "xyz789",
      "updatedAt": "xyz789",
      "createdBy": ShortEmployeeResponse,
      "photo": "xyz789",
      "email": "xyz789",
      "phone": "abc123",
      "company": IdNameResponse,
      "timezone": TimezoneResponse,
      "firstName": "abc123",
      "lastName": "abc123",
      "driverId": "abc123",
      "dutyStatus": IdNameResponse,
      "logSettings": LogSettingsResponse,
      "driverLicense": LicenseResponse,
      "dutyStatusSetAt": "xyz789",
      "lastAppSyncedAt": "abc123",
      "lastActiveAt": "xyz789",
      "terminalAddress": AddressResponse,
      "manualLocation": LocationResponse,
      "calculatedLocation": LocationResponse,
      "currentAssets": [EmbeddedAssetResponse],
      "currentVehicle": EmbeddedVehicleResponse,
      "alertBeforeViolation": IdNameResponse
    }
  }
}
Queries

driverTripHistory

Response

Returns [TripPointResponse!]!

Arguments
Name Description
query - DriverTripHistoryQuery!

Example

Query
query DriverTripHistory($query: DriverTripHistoryQuery!) {
  driverTripHistory(query: $query) {
    location {
      location
      latitude
      longitude
    }
    id
    state
    odometer {
      value
      unit {
        ...OdometerUnitResponseFragment
      }
    }
    vehicle {
      id
      number
      year
      vin
      model
      make
    }
    driver {
      id
      username
      firstName
      lastName
      driverId
    }
    status {
      name
      id
    }
    createdAt
    speed {
      value
      unit {
        ...SpeedUnitResponseFragment
      }
    }
    engineHours
    fuelEconomy
    fuelLevel
  }
}
Variables
{"query": DriverTripHistoryQuery}
Response
{
  "data": {
    "driverTripHistory": [
      {
        "location": LocationResponse,
        "id": "abc123",
        "state": "abc123",
        "odometer": OdometerResponse,
        "vehicle": EmbeddedVehicleResponse,
        "driver": EmbeddedDriverResponse,
        "status": IdNameResponse,
        "createdAt": "abc123",
        "speed": SpeedResponse,
        "engineHours": 987,
        "fuelEconomy": 123,
        "fuelLevel": 123
      }
    ]
  }
}
Queries

drivers

Response

Returns a PaginatedDriversResponse!

Arguments
Name Description
query - DriversQuery

Example

Query
query Drivers($query: DriversQuery) {
  drivers(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    drivers {
      id
      hos {
        ...HOSResponseFragment
      }
      appDevice {
        ...AppDeviceResponseFragment
      }
      groups {
        ...ShortGroupResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      username
      carrier {
        ...DriverCarrierResponseFragment
      }
      createdAt
      updatedAt
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      photo
      email
      phone
      company {
        ...IdNameResponseFragment
      }
      timezone {
        ...TimezoneResponseFragment
      }
      firstName
      lastName
      driverId
      dutyStatus {
        ...IdNameResponseFragment
      }
      logSettings {
        ...LogSettingsResponseFragment
      }
      driverLicense {
        ...LicenseResponseFragment
      }
      dutyStatusSetAt
      lastAppSyncedAt
      lastActiveAt
      terminalAddress {
        ...AddressResponseFragment
      }
      manualLocation {
        ...LocationResponseFragment
      }
      calculatedLocation {
        ...LocationResponseFragment
      }
      currentAssets {
        ...EmbeddedAssetResponseFragment
      }
      currentVehicle {
        ...EmbeddedVehicleResponseFragment
      }
      alertBeforeViolation {
        ...IdNameResponseFragment
      }
    }
  }
}
Variables
{"query": DriversQuery}
Response
{
  "data": {
    "drivers": {
      "pagination": PaginationResponse,
      "drivers": [DriverResponse]
    }
  }
}
Queries

employee

Response

Returns an EmployeeResponse!

Arguments
Name Description
query - EmployeeQuery!

Example

Query
query Employee($query: EmployeeQuery!) {
  employee(query: $query) {
    groups {
      name
      id
    }
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    phone
    company {
      name
      id
    }
    lastActiveAt
    id
    role {
      name
      id
    }
    status {
      name
      id
    }
    username
    createdAt
    updatedAt
    photo
    email
    timezone {
      name
      id
      code
    }
    firstName
    lastName
  }
}
Variables
{"query": EmployeeQuery}
Response
{
  "data": {
    "employee": {
      "groups": [ShortGroupResponse],
      "createdBy": ShortEmployeeResponse,
      "phone": "abc123",
      "company": IdNameResponse,
      "lastActiveAt": "xyz789",
      "id": "xyz789",
      "role": ShortRoleResponse,
      "status": IdNameResponse,
      "username": "xyz789",
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "photo": "abc123",
      "email": "abc123",
      "timezone": TimezoneResponse,
      "firstName": "xyz789",
      "lastName": "abc123"
    }
  }
}
Queries

employees

Response

Returns a PaginatedEmployeesResponse!

Arguments
Name Description
query - EmployeesQuery

Example

Query
query Employees($query: EmployeesQuery) {
  employees(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    employees {
      groups {
        ...ShortGroupResponseFragment
      }
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      phone
      company {
        ...IdNameResponseFragment
      }
      lastActiveAt
      id
      role {
        ...ShortRoleResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      username
      createdAt
      updatedAt
      photo
      email
      timezone {
        ...TimezoneResponseFragment
      }
      firstName
      lastName
    }
  }
}
Variables
{"query": EmployeesQuery}
Response
{
  "data": {
    "employees": {
      "pagination": PaginationResponse,
      "employees": [EmployeeResponse]
    }
  }
}
Queries

live

Response

Returns [LiveResponse!]!

Arguments
Name Description
query - LiveQuery

Example

Query
query Live($query: LiveQuery) {
  live(query: $query) {
    entity {
      description
      name
      id
      type {
        ...IdNameResponseFragment
      }
    }
    id
    odometer {
      value
      unit {
        ...OdometerUnitResponseFragment
      }
    }
    speed {
      value
      unit {
        ...SpeedUnitResponseFragment
      }
    }
    assetsIds
    driverId
    engineHours
    fuelEconomy
    fuelLevel
    manualLocation {
      location
      latitude
      longitude
    }
    calculatedLocation {
      location
      latitude
      longitude
    }
    entityStatus {
      name
      id
    }
    lastDutyStatusAt
    lastCalculatedLocationAt
    lastManualLocationAt
  }
}
Variables
{"query": LiveQuery}
Response
{
  "data": {
    "live": [
      {
        "entity": LiveEntityResponse,
        "id": "abc123",
        "odometer": OdometerResponse,
        "speed": SpeedResponse,
        "assetsIds": ["abc123"],
        "driverId": "xyz789",
        "engineHours": 123,
        "fuelEconomy": 123,
        "fuelLevel": 987,
        "manualLocation": LocationResponse,
        "calculatedLocation": LocationResponse,
        "entityStatus": IdNameResponse,
        "lastDutyStatusAt": "abc123",
        "lastCalculatedLocationAt": "xyz789",
        "lastManualLocationAt": "abc123"
      }
    ]
  }
}
Queries

log

Response

Returns a LogResponse!

Arguments
Name Description
query - LogQuery!

Example

Query
query Log($query: LogQuery!) {
  log(query: $query) {
    events {
      origin {
        ...IdNameResponseFragment
      }
      location {
        ...LogEventLocationResponseFragment
      }
      id
      type {
        ...IdNameResponseFragment
      }
      time
      notes
      vehicle {
        ...EmbeddedVehicleResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      sequenceId
      eldDevice {
        ...EmbeddedEldDeviceResponseFragment
      }
      createdBy {
        ...EmbeddedEmployeeResponseFragment
      }
      updatedBy {
        ...EmbeddedEmployeeResponseFragment
      }
      totalOdometer
      totalEngineHours
      certificationDate
      malfunctionIndicatorStatus {
        ...IdNameResponseFragment
      }
      malfunctionDiagnosticCode {
        ...IdNameResponseFragment
      }
      diagnosticIndicatorStatus {
        ...IdNameResponseFragment
      }
    }
    violations {
      endTime
      startTime
      id
      type {
        ...IdNameResponseFragment
      }
      driver {
        ...EmbeddedDriverResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
    }
    suggestion {
      events {
        ...SuggestionEventResponseFragment
      }
      id
      status {
        ...IdNameResponseFragment
      }
      carrier {
        ...DriverCarrierResponseFragment
      }
      vehicles {
        ...EmbeddedVehicleResponseFragment
      }
      coDrivers {
        ...EmbeddedDriverResponseFragment
      }
      createdAt
      createdBy {
        ...EmbeddedEmployeeResponseFragment
      }
      deletedBy {
        ...EmbeddedEmployeeResponseFragment
      }
      approvedBy {
        ...EmbeddedEmployeeResponseFragment
      }
      deletedAt
      approvedAt
      assets {
        ...EmbeddedAssetResponseFragment
      }
      terminalAddress {
        ...AddressResponseFragment
      }
      shippingDocuments
      changedFields
    }
    odometers {
      vehicle {
        ...EmbeddedVehicleResponseFragment
      }
      odometers {
        ...LogOdometerResponseFragment
      }
    }
    coDrivers {
      id
      username
      firstName
      lastName
      driverId
    }
    previousLog {
      id
      date
      utcEndTime
      utcStartTime
    }
    nextLog {
      id
      date
      utcEndTime
      utcStartTime
    }
    inspectionReports {
      entity {
        ...MaintenanceEntityResponseFragment
      }
      id
      type {
        ...IdNameResponseFragment
      }
      odometer
      dateTime
      carrierName
      defectsNames
    }
    suggestionsHistory {
      events {
        ...SuggestionEventResponseFragment
      }
      id
      status {
        ...IdNameResponseFragment
      }
      carrier {
        ...DriverCarrierResponseFragment
      }
      vehicles {
        ...EmbeddedVehicleResponseFragment
      }
      coDrivers {
        ...EmbeddedDriverResponseFragment
      }
      createdAt
      createdBy {
        ...EmbeddedEmployeeResponseFragment
      }
      deletedBy {
        ...EmbeddedEmployeeResponseFragment
      }
      approvedBy {
        ...EmbeddedEmployeeResponseFragment
      }
      deletedAt
      approvedAt
      assets {
        ...EmbeddedAssetResponseFragment
      }
      terminalAddress {
        ...AddressResponseFragment
      }
      shippingDocuments
      changedFields
    }
    driverSignature
    shippingDocuments
    id
    date
    restBreak {
      name
      id
    }
    driver {
      id
      username
      firstName
      lastName
      driverId
    }
    cargoType {
      name
      id
    }
    restart {
      name
      id
    }
    wellSite {
      name
      id
    }
    carrier {
      name
      address {
        ...AddressResponseFragment
      }
      dotNumber
    }
    vehicles {
      id
      number
      year
      vin
      model
      make
    }
    createdAt
    updatedAt
    assets {
      id
      number
      year
      model
      make
    }
    utcEndTime
    timezone {
      name
      id
      code
    }
    cycle {
      name
      id
    }
    shortHaulException {
      name
      id
    }
    weeklyHourLimit {
      name
      id
    }
    cdlDriverType {
      name
      id
    }
    terminalAddress {
      state
      street
      city
      zipCode
    }
    utcStartTime
    adverseConditionsException {
      name
      id
    }
  }
}
Variables
{"query": LogQuery}
Response
{
  "data": {
    "log": {
      "events": [LogEventResponse],
      "violations": [ViolationResponse],
      "suggestion": SuggestionResponse,
      "odometers": [LogVehicleOdometerResponse],
      "coDrivers": [EmbeddedDriverResponse],
      "previousLog": NavigationLogResponse,
      "nextLog": NavigationLogResponse,
      "inspectionReports": [ShortMaintenanceResponse],
      "suggestionsHistory": [SuggestionResponse],
      "driverSignature": "abc123",
      "shippingDocuments": "xyz789",
      "id": "abc123",
      "date": "abc123",
      "restBreak": IdNameResponse,
      "driver": EmbeddedDriverResponse,
      "cargoType": IdNameResponse,
      "restart": IdNameResponse,
      "wellSite": IdNameResponse,
      "carrier": DriverCarrierResponse,
      "vehicles": [EmbeddedVehicleResponse],
      "createdAt": "xyz789",
      "updatedAt": "xyz789",
      "assets": [EmbeddedAssetResponse],
      "utcEndTime": "xyz789",
      "timezone": TimezoneResponse,
      "cycle": IdNameResponse,
      "shortHaulException": IdNameResponse,
      "weeklyHourLimit": IdNameResponse,
      "cdlDriverType": IdNameResponse,
      "terminalAddress": AddressResponse,
      "utcStartTime": "xyz789",
      "adverseConditionsException": IdNameResponse
    }
  }
}
Queries

logs

Response

Returns a PaginatedLogsResponse!

Arguments
Name Description
query - LogsQuery

Example

Query
query Logs($query: LogsQuery) {
  logs(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    logs {
      violations {
        ...ShortViolationResponseFragment
      }
      formAndManner {
        ...ShortFormAndMannerResponseFragment
      }
      totalDistance {
        ...DistanceResponseFragment
      }
      totalDefects
      eventDuration {
        ...EventDurationResponseFragment
      }
      totalInspectionReports
      id
      date
      restBreak {
        ...IdNameResponseFragment
      }
      driver {
        ...EmbeddedDriverResponseFragment
      }
      cargoType {
        ...IdNameResponseFragment
      }
      restart {
        ...IdNameResponseFragment
      }
      wellSite {
        ...IdNameResponseFragment
      }
      carrier {
        ...DriverCarrierResponseFragment
      }
      vehicles {
        ...EmbeddedVehicleResponseFragment
      }
      createdAt
      updatedAt
      assets {
        ...EmbeddedAssetResponseFragment
      }
      utcEndTime
      timezone {
        ...TimezoneResponseFragment
      }
      cycle {
        ...IdNameResponseFragment
      }
      shortHaulException {
        ...IdNameResponseFragment
      }
      weeklyHourLimit {
        ...IdNameResponseFragment
      }
      cdlDriverType {
        ...IdNameResponseFragment
      }
      terminalAddress {
        ...AddressResponseFragment
      }
      utcStartTime
      adverseConditionsException {
        ...IdNameResponseFragment
      }
    }
  }
}
Variables
{"query": LogsQuery}
Response
{
  "data": {
    "logs": {
      "pagination": PaginationResponse,
      "logs": [ListedLogResponse]
    }
  }
}
Queries

maintenance

Response

Returns a MaintenanceResponse!

Arguments
Name Description
query - MaintenanceQuery!

Example

Query
query Maintenance($query: MaintenanceQuery!) {
  maintenance(query: $query) {
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    driverSignature
    inspectedParts {
      category
      id
      type {
        ...IdNameResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      defectType {
        ...IdNameResponseFragment
      }
      resolvedBy
      attachments {
        ...AttachmentResponseFragment
      }
      reportedNote
      resolvedNote
      resolvedDate
    }
    entity {
      name
      id
      type {
        ...IdNameResponseFragment
      }
    }
    id
    type {
      name
      id
    }
    number
    odometer
    status {
      name
      id
    }
    createdAt
    updatedAt
    dateTime
    carrierName
  }
}
Variables
{"query": MaintenanceQuery}
Response
{
  "data": {
    "maintenance": {
      "createdBy": ShortEmployeeResponse,
      "driverSignature": "abc123",
      "inspectedParts": [InspectedPartResponse],
      "entity": MaintenanceEntityResponse,
      "id": "xyz789",
      "type": IdNameResponse,
      "number": 987,
      "odometer": 987,
      "status": IdNameResponse,
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "dateTime": "xyz789",
      "carrierName": "abc123"
    }
  }
}
Queries

maintenances

Response

Returns a PaginatedMaintenancesResponse!

Arguments
Name Description
query - MaintenancesQuery

Example

Query
query Maintenances($query: MaintenancesQuery) {
  maintenances(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    maintenances {
      createdBy {
        ...ShortEmployeeWithPhotoResponseFragment
      }
      defectsNames
      entity {
        ...MaintenanceEntityResponseFragment
      }
      id
      type {
        ...IdNameResponseFragment
      }
      number
      odometer
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
      dateTime
      carrierName
    }
  }
}
Variables
{"query": MaintenancesQuery}
Response
{
  "data": {
    "maintenances": {
      "pagination": PaginationResponse,
      "maintenances": [ListedMaintenanceResponse]
    }
  }
}
Queries

reportDriversOverview

Response

Returns a PaginatedDriversResponse!

Arguments
Name Description
query - ReportDriversOverviewQuery

Example

Query
query ReportDriversOverview($query: ReportDriversOverviewQuery) {
  reportDriversOverview(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    drivers {
      id
      hos {
        ...HOSResponseFragment
      }
      appDevice {
        ...AppDeviceResponseFragment
      }
      groups {
        ...ShortGroupResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      username
      carrier {
        ...DriverCarrierResponseFragment
      }
      createdAt
      updatedAt
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      photo
      email
      phone
      company {
        ...IdNameResponseFragment
      }
      timezone {
        ...TimezoneResponseFragment
      }
      firstName
      lastName
      driverId
      dutyStatus {
        ...IdNameResponseFragment
      }
      logSettings {
        ...LogSettingsResponseFragment
      }
      driverLicense {
        ...LicenseResponseFragment
      }
      dutyStatusSetAt
      lastAppSyncedAt
      lastActiveAt
      terminalAddress {
        ...AddressResponseFragment
      }
      manualLocation {
        ...LocationResponseFragment
      }
      calculatedLocation {
        ...LocationResponseFragment
      }
      currentAssets {
        ...EmbeddedAssetResponseFragment
      }
      currentVehicle {
        ...EmbeddedVehicleResponseFragment
      }
      alertBeforeViolation {
        ...IdNameResponseFragment
      }
    }
  }
}
Variables
{"query": ReportDriversOverviewQuery}
Response
{
  "data": {
    "reportDriversOverview": {
      "pagination": PaginationResponse,
      "drivers": [DriverResponse]
    }
  }
}
Queries

reportDriversWorkload

Response

Returns a PaginatedDriversWorkloadResponse!

Arguments
Name Description
query - ReportDriversWorkloadQuery

Example

Query
query ReportDriversWorkload($query: ReportDriversWorkloadQuery) {
  reportDriversWorkload(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    drivers {
      id
      totalOnDuty
      firstName
      lastName
      driverId
      totalOffDuty
      totalSleeper
      totalDriving
      totalTimeWorked
      totalDistance
    }
  }
}
Variables
{"query": ReportDriversWorkloadQuery}
Response
{
  "data": {
    "reportDriversWorkload": {
      "pagination": PaginationResponse,
      "drivers": [DriverWorkloadResponse]
    }
  }
}
Queries

reportEmployeesOverview

Response

Returns a PaginatedEmployeesResponse!

Arguments
Name Description
query - ReportEmployeesOverviewQuery

Example

Query
query ReportEmployeesOverview($query: ReportEmployeesOverviewQuery) {
  reportEmployeesOverview(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    employees {
      groups {
        ...ShortGroupResponseFragment
      }
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      phone
      company {
        ...IdNameResponseFragment
      }
      lastActiveAt
      id
      role {
        ...ShortRoleResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      username
      createdAt
      updatedAt
      photo
      email
      timezone {
        ...TimezoneResponseFragment
      }
      firstName
      lastName
    }
  }
}
Variables
{"query": ReportEmployeesOverviewQuery}
Response
{
  "data": {
    "reportEmployeesOverview": {
      "pagination": PaginationResponse,
      "employees": [EmployeeResponse]
    }
  }
}
Queries

reportFmcsa

Response

Returns a PaginatedFmcsaReportsResponse!

Arguments
Name Description
query - ReportFmcsaQuery

Example

Query
query ReportFmcsa($query: ReportFmcsaQuery) {
  reportFmcsa(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    fmcsaReports {
      endTime
      startTime
      id
      comment
      driver {
        ...ShortDriverResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      createdAt
      processedTime
    }
  }
}
Variables
{"query": ReportFmcsaQuery}
Response
{
  "data": {
    "reportFmcsa": {
      "pagination": PaginationResponse,
      "fmcsaReports": [FmcsaReportResponse]
    }
  }
}
Queries

reportHosRecap

Response

Returns a PaginatedDriversWorkloadResponse!

Arguments
Name Description
query - ReportHosRecapQuery

Example

Query
query ReportHosRecap($query: ReportHosRecapQuery) {
  reportHosRecap(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    drivers {
      id
      totalOnDuty
      firstName
      lastName
      driverId
      totalOffDuty
      totalSleeper
      totalDriving
      totalTimeWorked
      totalDistance
    }
  }
}
Variables
{"query": ReportHosRecapQuery}
Response
{
  "data": {
    "reportHosRecap": {
      "pagination": PaginationResponse,
      "drivers": [DriverWorkloadResponse]
    }
  }
}
Queries

sharedLocations

Response

Returns [SharedLocationResponse!]!

Arguments
Name Description
query - SharedLocationsQuery!

Example

Query
query SharedLocations($query: SharedLocationsQuery!) {
  sharedLocations(query: $query) {
    id
    createdAt
    updatedAt
    expiresAt
    isDriverPhoneNumberVisible
    isShippingDocumentsVisible
    isDriverDutyStatusVisible
  }
}
Variables
{"query": SharedLocationsQuery}
Response
{
  "data": {
    "sharedLocations": [
      {
        "id": "abc123",
        "createdAt": "abc123",
        "updatedAt": "abc123",
        "expiresAt": "xyz789",
        "isDriverPhoneNumberVisible": true,
        "isShippingDocumentsVisible": false,
        "isDriverDutyStatusVisible": true
      }
    ]
  }
}
Queries

vehicle

Response

Returns a VehicleResponse!

Arguments
Name Description
query - VehicleQuery!

Example

Query
query Vehicle($query: VehicleQuery!) {
  vehicle(query: $query) {
    groups {
      name
      id
    }
    updatedBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    id
    number
    year
    vin
    notes
    fuelType {
      name
      id
    }
    odometer {
      name
      id
    }
    status {
      name
      id
    }
    createdAt
    updatedAt
    eldDevice {
      name
      id
      macAddress
      model {
        ...IdNameResponseFragment
      }
      serialNumber
    }
    createdBy {
      id
      status {
        ...IdNameResponseFragment
      }
      firstName
      lastName
    }
    license {
      state
      number
    }
    model
    make
    manualLocation {
      location
      latitude
      longitude
    }
    calculatedLocation {
      location
      latitude
      longitude
    }
    defectsCount
    inspectionForm {
      name
      id
    }
    currentDriver {
      id
      username
      firstName
      lastName
      driverId
    }
  }
}
Variables
{"query": VehicleQuery}
Response
{
  "data": {
    "vehicle": {
      "groups": [ShortGroupResponse],
      "updatedBy": ShortEmployeeResponse,
      "id": "xyz789",
      "number": "xyz789",
      "year": 123,
      "vin": "xyz789",
      "notes": "abc123",
      "fuelType": IdNameResponse,
      "odometer": IdNameResponse,
      "status": IdNameResponse,
      "createdAt": "xyz789",
      "updatedAt": "xyz789",
      "eldDevice": ShortEldDeviceResponse,
      "createdBy": ShortEmployeeResponse,
      "license": LicenseResponse,
      "model": "abc123",
      "make": "abc123",
      "manualLocation": LocationResponse,
      "calculatedLocation": LocationResponse,
      "defectsCount": 987,
      "inspectionForm": ShortInspectionFormResponse,
      "currentDriver": EmbeddedDriverResponse
    }
  }
}
Queries

vehicleTripHistory

Response

Returns [TripPointResponse!]!

Arguments
Name Description
query - VehicleTripHistoryQuery!

Example

Query
query VehicleTripHistory($query: VehicleTripHistoryQuery!) {
  vehicleTripHistory(query: $query) {
    location {
      location
      latitude
      longitude
    }
    id
    state
    odometer {
      value
      unit {
        ...OdometerUnitResponseFragment
      }
    }
    vehicle {
      id
      number
      year
      vin
      model
      make
    }
    driver {
      id
      username
      firstName
      lastName
      driverId
    }
    status {
      name
      id
    }
    createdAt
    speed {
      value
      unit {
        ...SpeedUnitResponseFragment
      }
    }
    engineHours
    fuelEconomy
    fuelLevel
  }
}
Variables
{"query": VehicleTripHistoryQuery}
Response
{
  "data": {
    "vehicleTripHistory": [
      {
        "location": LocationResponse,
        "id": "xyz789",
        "state": "abc123",
        "odometer": OdometerResponse,
        "vehicle": EmbeddedVehicleResponse,
        "driver": EmbeddedDriverResponse,
        "status": IdNameResponse,
        "createdAt": "xyz789",
        "speed": SpeedResponse,
        "engineHours": 123,
        "fuelEconomy": 987,
        "fuelLevel": 987
      }
    ]
  }
}
Queries

vehicles

Response

Returns a PaginatedVehiclesResponse!

Arguments
Name Description
query - VehiclesQuery

Example

Query
query Vehicles($query: VehiclesQuery) {
  vehicles(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    vehicles {
      groups {
        ...ShortGroupResponseFragment
      }
      updatedBy {
        ...ShortEmployeeWithPhotoResponseFragment
      }
      id
      number
      year
      vin
      notes
      fuelType {
        ...IdNameResponseFragment
      }
      odometer {
        ...IdNameResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
      eldDevice {
        ...ShortEldDeviceResponseFragment
      }
      createdBy {
        ...ShortEmployeeResponseFragment
      }
      license {
        ...LicenseResponseFragment
      }
      model
      make
      manualLocation {
        ...LocationResponseFragment
      }
      calculatedLocation {
        ...LocationResponseFragment
      }
      defectsCount
      inspectionForm {
        ...ShortInspectionFormResponseFragment
      }
      currentDriver {
        ...EmbeddedDriverResponseFragment
      }
    }
  }
}
Variables
{"query": VehiclesQuery}
Response
{
  "data": {
    "vehicles": {
      "pagination": PaginationResponse,
      "vehicles": [ListedVehicleResponse]
    }
  }
}
Queries

violations

Response

Returns a PaginatedViolationsResponse!

Arguments
Name Description
query - ViolationsQuery

Example

Query
query Violations($query: ViolationsQuery) {
  violations(query: $query) {
    pagination {
      itemsOnPage
      totalItems
      pageNumber
      totalPages
      itemsPerPage
    }
    violations {
      endTime
      startTime
      id
      type {
        ...IdNameResponseFragment
      }
      driver {
        ...EmbeddedDriverResponseFragment
      }
      status {
        ...IdNameResponseFragment
      }
      createdAt
      updatedAt
    }
  }
}
Variables
{"query": ViolationsQuery}
Response
{
  "data": {
    "violations": {
      "pagination": PaginationResponse,
      "violations": [ViolationResponse]
    }
  }
}

Mutations

activateAsset

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ActivateAssetCommand!

Example

Query
mutation ActivateAsset($command: ActivateAssetCommand!) {
  activateAsset(command: $command) {
    status
  }
}
Variables
{"command": ActivateAssetCommand}
Response
{"data": {"activateAsset": {"status": false}}}
Mutations

activateDriver

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ActivateDriverCommand!

Example

Query
mutation ActivateDriver($command: ActivateDriverCommand!) {
  activateDriver(command: $command) {
    status
  }
}
Variables
{"command": ActivateDriverCommand}
Response
{"data": {"activateDriver": {"status": false}}}
Mutations

activateVehicle

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ActivateVehicleCommand!

Example

Query
mutation ActivateVehicle($command: ActivateVehicleCommand!) {
  activateVehicle(command: $command) {
    status
  }
}
Variables
{"command": ActivateVehicleCommand}
Response
{"data": {"activateVehicle": {"status": false}}}
Mutations

archiveDocument

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ArchiveDocumentCommand!

Example

Query
mutation ArchiveDocument($command: ArchiveDocumentCommand!) {
  archiveDocument(command: $command) {
    status
  }
}
Variables
{"command": ArchiveDocumentCommand}
Response
{"data": {"archiveDocument": {"status": true}}}
Mutations

createAsset

Response

Returns a CreationResponse!

Arguments
Name Description
command - CreateAssetCommand!

Example

Query
mutation CreateAsset($command: CreateAssetCommand!) {
  createAsset(command: $command) {
    id
  }
}
Variables
{"command": CreateAssetCommand}
Response
{"data": {"createAsset": {"id": "abc123"}}}
Mutations

createDocument

Response

Returns a CreationResponse!

Arguments
Name Description
command - CreateDocumentCommand!

Example

Query
mutation CreateDocument($command: CreateDocumentCommand!) {
  createDocument(command: $command) {
    id
  }
}
Variables
{"command": CreateDocumentCommand}
Response
{
  "data": {
    "createDocument": {"id": "xyz789"}
  }
}
Mutations

createDriver

Response

Returns a CreationResponse!

Arguments
Name Description
command - CreateDriverCommand!

Example

Query
mutation CreateDriver($command: CreateDriverCommand!) {
  createDriver(command: $command) {
    id
  }
}
Variables
{"command": CreateDriverCommand}
Response
{"data": {"createDriver": {"id": "abc123"}}}
Mutations

createSharedLocation

Response

Returns a CreationResponse!

Arguments
Name Description
command - CreateSharedLocationCommand!

Example

Query
mutation CreateSharedLocation($command: CreateSharedLocationCommand!) {
  createSharedLocation(command: $command) {
    id
  }
}
Variables
{"command": CreateSharedLocationCommand}
Response
{
  "data": {
    "createSharedLocation": {"id": "abc123"}
  }
}
Mutations

createVehicle

Response

Returns a CreationResponse!

Arguments
Name Description
command - CreateVehicleCommand!

Example

Query
mutation CreateVehicle($command: CreateVehicleCommand!) {
  createVehicle(command: $command) {
    id
  }
}
Variables
{"command": CreateVehicleCommand}
Response
{
  "data": {
    "createVehicle": {"id": "abc123"}
  }
}
Mutations

deactivateAsset

Response

Returns a SucceedResponse!

Arguments
Name Description
command - DeactivateAssetCommand!

Example

Query
mutation DeactivateAsset($command: DeactivateAssetCommand!) {
  deactivateAsset(command: $command) {
    status
  }
}
Variables
{"command": DeactivateAssetCommand}
Response
{"data": {"deactivateAsset": {"status": false}}}
Mutations

deactivateDriver

Response

Returns a SucceedResponse!

Arguments
Name Description
command - DeactivateDriverCommand!

Example

Query
mutation DeactivateDriver($command: DeactivateDriverCommand!) {
  deactivateDriver(command: $command) {
    status
  }
}
Variables
{"command": DeactivateDriverCommand}
Response
{"data": {"deactivateDriver": {"status": false}}}
Mutations

deactivateVehicle

Response

Returns a SucceedResponse!

Arguments
Name Description
command - DeactivateVehicleCommand!

Example

Query
mutation DeactivateVehicle($command: DeactivateVehicleCommand!) {
  deactivateVehicle(command: $command) {
    status
  }
}
Variables
{"command": DeactivateVehicleCommand}
Response
{"data": {"deactivateVehicle": {"status": true}}}
Mutations

deleteDocument

Response

Returns a SucceedResponse!

Arguments
Name Description
command - DeleteDocumentCommand!

Example

Query
mutation DeleteDocument($command: DeleteDocumentCommand!) {
  deleteDocument(command: $command) {
    status
  }
}
Variables
{"command": DeleteDocumentCommand}
Response
{"data": {"deleteDocument": {"status": true}}}
Mutations

deleteSharedLocation

Response

Returns a SucceedResponse!

Arguments
Name Description
command - DeleteSharedLocationCommand!

Example

Query
mutation DeleteSharedLocation($command: DeleteSharedLocationCommand!) {
  deleteSharedLocation(command: $command) {
    status
  }
}
Variables
{"command": DeleteSharedLocationCommand}
Response
{"data": {"deleteSharedLocation": {"status": false}}}
Mutations

generateFileUploadUrl

Response

Returns a FileUploadUrlResponse!

Arguments
Name Description
command - GenerateFileUploadUrlCommand!

Example

Query
mutation GenerateFileUploadUrl($command: GenerateFileUploadUrlCommand!) {
  generateFileUploadUrl(command: $command) {
    fileName
    fileUploadUrl
  }
}
Variables
{"command": GenerateFileUploadUrlCommand}
Response
{
  "data": {
    "generateFileUploadUrl": {
      "fileName": "xyz789",
      "fileUploadUrl": "abc123"
    }
  }
}
Mutations

reopenInspectedPart

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ReopenInspectedPartCommand!

Example

Query
mutation ReopenInspectedPart($command: ReopenInspectedPartCommand!) {
  reopenInspectedPart(command: $command) {
    status
  }
}
Variables
{"command": ReopenInspectedPartCommand}
Response
{"data": {"reopenInspectedPart": {"status": false}}}
Mutations

resolveInspectedPart

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ResolveInspectedPartCommand!

Example

Query
mutation ResolveInspectedPart($command: ResolveInspectedPartCommand!) {
  resolveInspectedPart(command: $command) {
    status
  }
}
Variables
{"command": ResolveInspectedPartCommand}
Response
{"data": {"resolveInspectedPart": {"status": false}}}
Mutations

restoreDocument

Response

Returns a SucceedResponse!

Arguments
Name Description
command - RestoreDocumentCommand!

Example

Query
mutation RestoreDocument($command: RestoreDocumentCommand!) {
  restoreDocument(command: $command) {
    status
  }
}
Variables
{"command": RestoreDocumentCommand}
Response
{"data": {"restoreDocument": {"status": false}}}
Mutations

shareDocument

Response

Returns a SucceedResponse!

Arguments
Name Description
command - ShareDocumentCommand!

Example

Query
mutation ShareDocument($command: ShareDocumentCommand!) {
  shareDocument(command: $command) {
    status
  }
}
Variables
{"command": ShareDocumentCommand}
Response
{"data": {"shareDocument": {"status": false}}}
Mutations

updateAsset

Response

Returns a SucceedResponse!

Arguments
Name Description
command - UpdateAssetCommand!

Example

Query
mutation UpdateAsset($command: UpdateAssetCommand!) {
  updateAsset(command: $command) {
    status
  }
}
Variables
{"command": UpdateAssetCommand}
Response
{"data": {"updateAsset": {"status": true}}}
Mutations

updateDocument

Response

Returns a SucceedResponse!

Arguments
Name Description
command - UpdateDocumentCommand!

Example

Query
mutation UpdateDocument($command: UpdateDocumentCommand!) {
  updateDocument(command: $command) {
    status
  }
}
Variables
{"command": UpdateDocumentCommand}
Response
{"data": {"updateDocument": {"status": false}}}
Mutations

updateDriver

Response

Returns a SucceedResponse!

Arguments
Name Description
command - UpdateDriverCommand!

Example

Query
mutation UpdateDriver($command: UpdateDriverCommand!) {
  updateDriver(command: $command) {
    status
  }
}
Variables
{"command": UpdateDriverCommand}
Response
{"data": {"updateDriver": {"status": false}}}
Mutations

updateVehicle

Response

Returns a SucceedResponse!

Arguments
Name Description
command - UpdateVehicleCommand!

Example

Query
mutation UpdateVehicle($command: UpdateVehicleCommand!) {
  updateVehicle(command: $command) {
    status
  }
}
Variables
{"command": UpdateVehicleCommand}
Response
{"data": {"updateVehicle": {"status": false}}}

Types

ActivateAssetCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

ActivateDriverCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

ActivateVehicleCommand

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

AddressRequest

Fields
Input Field Description
street - String
city - String
state - String
zipCode - String
Example
{
  "street": "abc123",
  "city": "xyz789",
  "state": "abc123",
  "zipCode": "abc123"
}
Types

AddressResponse

Description

Postal address representation.

Fields
Field Name Description
state - String State or province code.
street - String Street line including number.
city - String City or locality.
zipCode - String ZIP or postal code.
Example
{
  "state": "abc123",
  "street": "abc123",
  "city": "abc123",
  "zipCode": "xyz789"
}
Types

AdverseConditionsExceptionTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

AlertBeforeViolationRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

AlertTypeResponse

Fields
Field Name Description
name - String!
id - String!
subjects - [IdNameResponse!]!
title - String!
Example
{
  "name": "abc123",
  "id": "xyz789",
  "subjects": [IdNameResponse],
  "title": "xyz789"
}
Types

AppDeviceResponse

Fields
Field Name Description
version - String
isUpToDate - Boolean
platform - IdNameResponse
Example
{
  "version": "abc123",
  "isUpToDate": false,
  "platform": IdNameResponse
}
Types

ArchiveDocumentCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

AssetFiltersRequest

Description

Filter object allowing clients to select assets by status, group, and type.

Fields
Input Field Description
statuses - [AssetStatusRequest] List of asset statuses to include.
groups - [GroupRequest] List of group IDs to include.
types - [AssetTypeRequest] List of asset types to include.
Example
{
  "statuses": [AssetStatusRequest],
  "groups": [GroupRequest],
  "types": [AssetTypeRequest]
}
Types

AssetLengthRequest

Fields
Input Field Description
value - Int
unit - AssetLengthUnitTypeRequest
Example
{"value": 987, "unit": AssetLengthUnitTypeRequest}
Types

AssetLengthResponse

Fields
Field Name Description
value - Int
unit - IdNameResponse
Example
{"value": 987, "unit": IdNameResponse}
Types

AssetLengthUnitTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

AssetQuery

Description

Asset Query

Fields
Input Field Description
id - String Asset Query field ID
Example
{"id": "abc123"}
Types

AssetRequest

Fields
Input Field Description
id - String
number - String
Example
{
  "id": "xyz789",
  "number": "abc123"
}
Types

AssetResponse

Description

Complete Asset response used by the asset query.

Fields
Field Name Description
length - AssetLengthResponse Overall length of the asset.
groups - [ShortGroupResponse!]! Groups / tags assigned to this asset for filtering.
notes - String Free-form notes stored on the asset.
updatedBy - ShortEmployeeResponse! Last user to edit this asset.
gvwr - GrossWeightResponse Gross Vehicle Weight Rating (GVWR).
gawr - GrossWeightResponse Gross Axle Weight Rating (GAWR).
license - LicenseResponse Registration or plate license.
ownership - IdNameResponse Ownership type (e.g. PURCHASED, LEASED).
axles - Int Number of axles on the trailer or chassis.
manualLocation - LocationResponse Manually-reported location (from manager/driver).
calculatedLocation - LocationResponse Last GPS-calculated location (auto).
inspectionForm - ShortInspectionFormResponse! Default inspection form assigned to this asset.
currentDriver - EmbeddedDriverResponse Driver currently linked to the asset, if any.
currentVehicle - EmbeddedVehicleResponse Vehicle currently hauling or paired with the asset, if any.
id - String! Unique ID of the Asset (UUID).
type - IdNameResponse! Operational type (e.g. TRAILER, CHASSIS).
number - String! Fleet-wide asset / trailer number displayed on equipment.
year - Int Model year (e.g. 2024).
vin - String Vehicle Identification Number, if applicable.
status - IdNameResponse! Current lifecycle status of the asset.
createdAt - String! ISO-8601 timestamp when the asset was first created (UTC).
updatedAt - String! ISO-8601 timestamp for the last update (UTC).
createdBy - ShortEmployeeResponse! User that originally created the record.
model - String Model or series (if provided).
make - String Manufacturer (e.g. Wabash, Great Dane).
Example
{
  "length": AssetLengthResponse,
  "groups": [ShortGroupResponse],
  "notes": "xyz789",
  "updatedBy": ShortEmployeeResponse,
  "gvwr": GrossWeightResponse,
  "gawr": GrossWeightResponse,
  "license": LicenseResponse,
  "ownership": IdNameResponse,
  "axles": 987,
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "inspectionForm": ShortInspectionFormResponse,
  "currentDriver": EmbeddedDriverResponse,
  "currentVehicle": EmbeddedVehicleResponse,
  "id": "abc123",
  "type": IdNameResponse,
  "number": "abc123",
  "year": 123,
  "vin": "xyz789",
  "status": IdNameResponse,
  "createdAt": "abc123",
  "updatedAt": "abc123",
  "createdBy": ShortEmployeeResponse,
  "model": "xyz789",
  "make": "xyz789"
}
Types

AssetStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

AssetTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "abc123"
}
Types

AssetsQuery

Description

Input object for the assets query supporting search, filters, pagination, and sorting.

Fields
Input Field Description
terms - String Free-text search across asset number, VIN, make, and model.
pagination - PaginationRequest Pagination options (page number and items per page).
filters - AssetFiltersRequest Filter set for narrowing the asset list.
sortBy - AssetsSortByRequest Sort order for the asset list.
Example
{
  "terms": "xyz789",
  "pagination": PaginationRequest,
  "filters": AssetFiltersRequest,
  "sortBy": AssetsSortByRequest
}
Types

AssetsSortByRequest

Description

Sorting options for the assets list.

Fields
Input Field Description
name - String Field to sort by (number, make, createdAt, updatedAt).
direction - String Sort direction: ASC or DESC.
Example
{
  "name": "xyz789",
  "direction": "abc123"
}
Types

AttachmentRequest

Fields
Input Field Description
id - String
name - String
path - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "path": "abc123"
}
Types

AttachmentResponse

Fields
Field Name Description
name - String!
id - String!
type - IdNameResponse!
size - Int!
url - String!
createdAt - String!
updatedAt - String
Example
{
  "name": "abc123",
  "id": "abc123",
  "type": IdNameResponse,
  "size": 987,
  "url": "abc123",
  "createdAt": "abc123",
  "updatedAt": "xyz789"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CargoTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

CdlDriverTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "abc123"
}
Types

CompanyRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

CompanyResponse

Description

Full company profile returned by the company query.

Fields
Field Name Description
name - String Company legal name.
id - String Unique company ID.
address - AddressResponse Primary company address.
currency - CurrencyResponse! Company base currency.
dotNumber - String USDOT number.
volumeUnit - IdNameResponse! Preferred volume unit (e.g. GALLONS, LITERS).
timezone - TimezoneResponse! Default company timezone.
logSettings - LogSettingsResponse Default log-book settings for drivers in this company.
Example
{
  "name": "xyz789",
  "id": "abc123",
  "address": AddressResponse,
  "currency": CurrencyResponse,
  "dotNumber": "xyz789",
  "volumeUnit": IdNameResponse,
  "timezone": TimezoneResponse,
  "logSettings": LogSettingsResponse
}
Types

ConstantsResponse

Fields
Field Name Description
eventTypes - [LogEventTypeResponse]
permissions - [IdNameResponse] All public permissions available for custom roles.
alertTypes - [AlertTypeResponse]
themes - [IdNameResponse]
currencies - [CurrencyResponse]
fuelVolumes - [IdNameResponse]
yesNo - [IdNameResponse]
lengthUnit - [IdNameResponse] Units of length (FEET, METER).
massUnit - [IdNameResponse] Units of mass/weight (POUNDS, KILOGRAMS).
notesPolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL, IF_DEFECT_FOUND).
cycleRules - [CycleRuleResponse]
timezones - [IdNameResponse]
cargoTypes - [IdNameResponse]
restarts - [IdNameResponse]
restBreaks - [IdNameResponse]
wellSites - [IdNameResponse]
yardMoves - [IdNameResponse]
fuelTypes - [IdNameResponse]
assetTypes - [IdNameResponse]
eventModes - [IdNameResponse]
languages - [IdNameResponse]
odometer - [IdNameResponse] Odometer units (MI or KM).
states - [IdNameResponse]
ownership - [IdNameResponse] Ownership types (PURCHASED, LEASED).
roleStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
groupStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
vehicleStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
assetStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
employeeStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
driverStatuses - [IdNameResponse] Status (ACTIVE, DEACTIVATED).
photoEvidencePolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL, IF_DEFECT_FOUND).
locationPolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL, IF_DEFECT_FOUND).
odometerPolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL, IF_DEFECT_FOUND).
shortHaulExceptions - [IdNameResponse]
weeklyHourLimits - [IdNameResponse]
cdlDriverTypes - [IdNameResponse]
personalConveyances - [IdNameResponse]
logIncrements - [IdNameResponse]
customFieldTypes - [IdNameResponse]
vehicleMakes - [IdNameResponse]
liveStatuses - [IdNameResponse]
liveEntities - [IdNameResponse]
maintenanceStatuses - [IdNameResponse]
maintenanceTypes - [IdNameResponse]
maintenanceEntities - [IdNameResponse]
documentDateTypes - [IdNameResponse]
eventOrigins - [IdNameResponse]
eventStatuses - [IdNameResponse]
logCombinedStatuses - [IdNameResponse]
alertTargetTypes - [IdNameResponse]
alertPriorities - [IdNameResponse]
alertMethods - [IdNameResponse]
employeeNumbers - [IdNameResponse]
eldDeviceModels - [IdNameResponse]
inspectAllPartsPolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL).
adverseConditionsExceptions - [IdNameResponse]
maintenanceCombinedStatuses - [IdNameResponse]
documentTypeStatuses - [IdNameResponse]
documentTypeAccesses - [IdNameResponse]
documentTypeAutoExtract - [IdNameResponse]
customFieldDateVisibility - [IdNameResponse]
customFieldNotesVisibility - [IdNameResponse]
customFieldAssetVisibility - [IdNameResponse]
customFieldDriverVisibility - [IdNameResponse]
alertVehicleActivities - [IdNameResponse]
inspectedPartStatuses - [IdNameResponse]
inspectionFormTargets - [IdNameResponse]
eldDeviceCombinedStatuses - [IdNameResponse]
driverSignatureDeclaration - String
alertBeforeViolation - [IdNameResponse]
inspectPreviousMissingDaysPolicy - [IdNameResponse] Policy (REQUIRED, OPTIONAL).
documentTypeCustomFieldNames - [IdNameResponse]
customFieldReferenceIdVisibility - [IdNameResponse]
customFieldFuelEntryVisibility - [IdNameResponse]
customFieldJurisdictionVisibility - [IdNameResponse]
customFieldFuelTypeVisibility - [IdNameResponse]
customFieldFuelVolumeVisibility - [IdNameResponse]
customFieldTotalCostVisibility - [IdNameResponse]
customFieldVendorNameVisibility - [IdNameResponse]
customFieldLocationVisibility - [IdNameResponse]
customFieldOdometerVisibility - [IdNameResponse]
customFieldVehicleVisibility - [IdNameResponse]
customFieldDriverLicenseVisibility - [IdNameResponse]
customFieldExpirationDateVisibility - [IdNameResponse]
customFieldInvoiceNumberVisibility - [IdNameResponse]
customFieldLoadNumberVisibility - [IdNameResponse]
customFieldPaymentMethodVisibility - [IdNameResponse]
customFieldCurrencyVisibility - [IdNameResponse]
customFieldTollLocationVisibility - [IdNameResponse]
resolvableInspectedPartStatuses - [IdNameResponse]
Example
{
  "eventTypes": [LogEventTypeResponse],
  "permissions": [IdNameResponse],
  "alertTypes": [AlertTypeResponse],
  "themes": [IdNameResponse],
  "currencies": [CurrencyResponse],
  "fuelVolumes": [IdNameResponse],
  "yesNo": [IdNameResponse],
  "lengthUnit": [IdNameResponse],
  "massUnit": [IdNameResponse],
  "notesPolicy": [IdNameResponse],
  "cycleRules": [CycleRuleResponse],
  "timezones": [IdNameResponse],
  "cargoTypes": [IdNameResponse],
  "restarts": [IdNameResponse],
  "restBreaks": [IdNameResponse],
  "wellSites": [IdNameResponse],
  "yardMoves": [IdNameResponse],
  "fuelTypes": [IdNameResponse],
  "assetTypes": [IdNameResponse],
  "eventModes": [IdNameResponse],
  "languages": [IdNameResponse],
  "odometer": [IdNameResponse],
  "states": [IdNameResponse],
  "ownership": [IdNameResponse],
  "roleStatuses": [IdNameResponse],
  "groupStatuses": [IdNameResponse],
  "vehicleStatuses": [IdNameResponse],
  "assetStatuses": [IdNameResponse],
  "employeeStatuses": [IdNameResponse],
  "driverStatuses": [IdNameResponse],
  "photoEvidencePolicy": [IdNameResponse],
  "locationPolicy": [IdNameResponse],
  "odometerPolicy": [IdNameResponse],
  "shortHaulExceptions": [IdNameResponse],
  "weeklyHourLimits": [IdNameResponse],
  "cdlDriverTypes": [IdNameResponse],
  "personalConveyances": [IdNameResponse],
  "logIncrements": [IdNameResponse],
  "customFieldTypes": [IdNameResponse],
  "vehicleMakes": [IdNameResponse],
  "liveStatuses": [IdNameResponse],
  "liveEntities": [IdNameResponse],
  "maintenanceStatuses": [IdNameResponse],
  "maintenanceTypes": [IdNameResponse],
  "maintenanceEntities": [IdNameResponse],
  "documentDateTypes": [IdNameResponse],
  "eventOrigins": [IdNameResponse],
  "eventStatuses": [IdNameResponse],
  "logCombinedStatuses": [IdNameResponse],
  "alertTargetTypes": [IdNameResponse],
  "alertPriorities": [IdNameResponse],
  "alertMethods": [IdNameResponse],
  "employeeNumbers": [IdNameResponse],
  "eldDeviceModels": [IdNameResponse],
  "inspectAllPartsPolicy": [IdNameResponse],
  "adverseConditionsExceptions": [IdNameResponse],
  "maintenanceCombinedStatuses": [IdNameResponse],
  "documentTypeStatuses": [IdNameResponse],
  "documentTypeAccesses": [IdNameResponse],
  "documentTypeAutoExtract": [IdNameResponse],
  "customFieldDateVisibility": [IdNameResponse],
  "customFieldNotesVisibility": [IdNameResponse],
  "customFieldAssetVisibility": [IdNameResponse],
  "customFieldDriverVisibility": [IdNameResponse],
  "alertVehicleActivities": [IdNameResponse],
  "inspectedPartStatuses": [IdNameResponse],
  "inspectionFormTargets": [IdNameResponse],
  "eldDeviceCombinedStatuses": [IdNameResponse],
  "driverSignatureDeclaration": "xyz789",
  "alertBeforeViolation": [IdNameResponse],
  "inspectPreviousMissingDaysPolicy": [IdNameResponse],
  "documentTypeCustomFieldNames": [IdNameResponse],
  "customFieldReferenceIdVisibility": [IdNameResponse],
  "customFieldFuelEntryVisibility": [IdNameResponse],
  "customFieldJurisdictionVisibility": [IdNameResponse],
  "customFieldFuelTypeVisibility": [IdNameResponse],
  "customFieldFuelVolumeVisibility": [IdNameResponse],
  "customFieldTotalCostVisibility": [IdNameResponse],
  "customFieldVendorNameVisibility": [IdNameResponse],
  "customFieldLocationVisibility": [IdNameResponse],
  "customFieldOdometerVisibility": [IdNameResponse],
  "customFieldVehicleVisibility": [IdNameResponse],
  "customFieldDriverLicenseVisibility": [IdNameResponse],
  "customFieldExpirationDateVisibility": [IdNameResponse],
  "customFieldInvoiceNumberVisibility": [IdNameResponse],
  "customFieldLoadNumberVisibility": [IdNameResponse],
  "customFieldPaymentMethodVisibility": [IdNameResponse],
  "customFieldCurrencyVisibility": [IdNameResponse],
  "customFieldTollLocationVisibility": [IdNameResponse],
  "resolvableInspectedPartStatuses": [IdNameResponse]
}
Types

CreateAssetCommand

Fields
Input Field Description
number - String
vin - String
year - Int
make - String
model - String
type - AssetTypeRequest
inspectionForm - InspectionFormRequest
license - LicenseRequest
notes - String
groups - [GroupRequest]
length - AssetLengthRequest
gvwr - GrossVehicleWeightRequest
gawr - GrossAxleWeightRequest
axles - Int
ownership - OwnershipRequest
Example
{
  "number": "xyz789",
  "vin": "xyz789",
  "year": 987,
  "make": "abc123",
  "model": "abc123",
  "type": AssetTypeRequest,
  "inspectionForm": InspectionFormRequest,
  "license": LicenseRequest,
  "notes": "abc123",
  "groups": [GroupRequest],
  "length": AssetLengthRequest,
  "gvwr": GrossVehicleWeightRequest,
  "gawr": GrossAxleWeightRequest,
  "axles": 123,
  "ownership": OwnershipRequest
}
Types

CreateAttachmentRequest

Fields
Input Field Description
name - String
path - String
Example
{
  "name": "abc123",
  "path": "abc123"
}
Types

CreateDocumentCommand

Fields
Input Field Description
type - DocumentTypeRequest
attachments - [CreateAttachmentRequest]
date - String
referenceId - String
notes - String
jurisdiction - JurisdictionRequest
fuelType - FuelTypeRequest
fuelVolume - FuelVolumeRequest
totalCost - TotalCostRequest
vendorName - String
location - String
odometer - OdometerRequest
driverLicense - String
expirationDate - String
invoiceNumber - String
loadNumber - String
paymentMethod - PaymentMethodRequest
currency - CurrencyRequest
tollLocation - String
vehicle - VehicleRequest
asset - AssetRequest
driver - DriverRequest
Example
{
  "type": DocumentTypeRequest,
  "attachments": [CreateAttachmentRequest],
  "date": "abc123",
  "referenceId": "xyz789",
  "notes": "xyz789",
  "jurisdiction": JurisdictionRequest,
  "fuelType": FuelTypeRequest,
  "fuelVolume": FuelVolumeRequest,
  "totalCost": TotalCostRequest,
  "vendorName": "xyz789",
  "location": "abc123",
  "odometer": OdometerRequest,
  "driverLicense": "abc123",
  "expirationDate": "xyz789",
  "invoiceNumber": "xyz789",
  "loadNumber": "xyz789",
  "paymentMethod": PaymentMethodRequest,
  "currency": CurrencyRequest,
  "tollLocation": "abc123",
  "vehicle": VehicleRequest,
  "asset": AssetRequest,
  "driver": DriverRequest
}
Types

CreateDriverCommand

Fields
Input Field Description
firstName - String
lastName - String
phone - String
driverId - String
email - String
username - String
password - String
groups - [GroupRequest]
driverLicense - LicenseRequest
carrier - DriverCarrierRequest
terminalAddress - AddressRequest
timezone - TimezoneRequest
logSettings - LogSettingsRequest
Example
{
  "firstName": "abc123",
  "lastName": "xyz789",
  "phone": "abc123",
  "driverId": "xyz789",
  "email": "abc123",
  "username": "xyz789",
  "password": "abc123",
  "groups": [GroupRequest],
  "driverLicense": LicenseRequest,
  "carrier": DriverCarrierRequest,
  "terminalAddress": AddressRequest,
  "timezone": TimezoneRequest,
  "logSettings": LogSettingsRequest
}
Types

CreateSharedLocationCommand

Fields
Input Field Description
vehicle - IdRequest
expiresAt - String
isDriverPhoneNumberVisible - Boolean
isShippingDocumentsVisible - Boolean
isDriverDutyStatusVisible - Boolean
Example
{
  "vehicle": IdRequest,
  "expiresAt": "abc123",
  "isDriverPhoneNumberVisible": false,
  "isShippingDocumentsVisible": false,
  "isDriverDutyStatusVisible": true
}
Types

CreateVehicleCommand

Fields
Input Field Description
number - String
vin - String
year - Int
make - String
model - String
license - LicenseRequest
odometer - OdometerUnitRequest
notes - String
fuelType - FuelTypeRequest
inspectionForm - InspectionFormRequest
groups - [GroupRequest]
eldDevice - EldDeviceRequest
Example
{
  "number": "abc123",
  "vin": "xyz789",
  "year": 123,
  "make": "xyz789",
  "model": "xyz789",
  "license": LicenseRequest,
  "odometer": OdometerUnitRequest,
  "notes": "abc123",
  "fuelType": FuelTypeRequest,
  "inspectionForm": InspectionFormRequest,
  "groups": [GroupRequest],
  "eldDevice": EldDeviceRequest
}
Types

CreatedByRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

CreationResponse

Fields
Field Name Description
id - String
Example
{"id": "abc123"}
Types

CurrencyRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

CurrencyResponse

Fields
Field Name Description
name - String!
id - String!
symbol - String!
Example
{
  "name": "abc123",
  "id": "xyz789",
  "symbol": "abc123"
}
Types

CycleRuleRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

CycleRuleResponse

Fields
Field Name Description
name - String
id - String
isCargoTypeRequired - Boolean
isRestartRequired - Boolean
isRestBreakRequired - Boolean
isWellSiteRequired - Boolean
isWeeklyHourLimitRequired - Boolean
isCdlDriverTypeRequired - Boolean
isShortHaulExceptionRequired - Boolean
isAdverseConditionsExceptionRequired - Boolean
Example
{
  "name": "abc123",
  "id": "abc123",
  "isCargoTypeRequired": true,
  "isRestartRequired": true,
  "isRestBreakRequired": false,
  "isWellSiteRequired": false,
  "isWeeklyHourLimitRequired": true,
  "isCdlDriverTypeRequired": true,
  "isShortHaulExceptionRequired": true,
  "isAdverseConditionsExceptionRequired": false
}
Types

DeactivateAssetCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

DeactivateDriverCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

DeactivateVehicleCommand

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

DeleteDocumentCommand

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

DeleteSharedLocationCommand

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

DistanceResponse

Fields
Field Name Description
value - Int!
unit - OdometerUnitResponse!
Example
{"value": 123, "unit": OdometerUnitResponse}
Types

DocumentEntitiesResponse

Fields
Field Name Description
vehicle - EmbeddedVehicleResponse
asset - EmbeddedAssetResponse
driver - EmbeddedDriverResponse
Example
{
  "vehicle": EmbeddedVehicleResponse,
  "asset": EmbeddedAssetResponse,
  "driver": EmbeddedDriverResponse
}
Types

DocumentFiltersRequest

Fields
Input Field Description
type - DocumentTypeRequest
status - DocumentStatusTypeRequest
createdBy - CreatedByRequest
createdAt - String
referenceId - String
invoiceNumber - String
loadNumber - String
vendorName - String
vehicle - VehicleRequest
asset - AssetRequest
driver - DriverRequest
Example
{
  "type": DocumentTypeRequest,
  "status": DocumentStatusTypeRequest,
  "createdBy": CreatedByRequest,
  "createdAt": "abc123",
  "referenceId": "xyz789",
  "invoiceNumber": "abc123",
  "loadNumber": "abc123",
  "vendorName": "abc123",
  "vehicle": VehicleRequest,
  "asset": AssetRequest,
  "driver": DriverRequest
}
Types

DocumentQuery

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

DocumentResponse

Fields
Field Name Description
createdBy - ShortEmployeeResponse!
updatedBy - ShortEmployeeResponse!
attachments - [AttachmentResponse]
sharedDrivers - [ShortDriverResponse]
sharedGroups - [ShortGroupResponse]
entities - DocumentEntitiesResponse
name - String!
id - String!
type - IdNameResponse!
number - Int!
date - String
referenceId - String
notes - String
status - IdNameResponse!
createdAt - String!
updatedAt - String!
Example
{
  "createdBy": ShortEmployeeResponse,
  "updatedBy": ShortEmployeeResponse,
  "attachments": [AttachmentResponse],
  "sharedDrivers": [ShortDriverResponse],
  "sharedGroups": [ShortGroupResponse],
  "entities": DocumentEntitiesResponse,
  "name": "abc123",
  "id": "xyz789",
  "type": IdNameResponse,
  "number": 123,
  "date": "xyz789",
  "referenceId": "xyz789",
  "notes": "abc123",
  "status": IdNameResponse,
  "createdAt": "abc123",
  "updatedAt": "xyz789"
}
Types

DocumentStatusTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

DocumentTypeCustomFieldDocumentDateResponse

Fields
Field Name Description
autoExtract - IdNameResponse
prompt - String
visibility - IdNameResponse
visibilityName - String
includesTime - Boolean
visibilityDisplayName - String
Example
{
  "autoExtract": IdNameResponse,
  "prompt": "xyz789",
  "visibility": IdNameResponse,
  "visibilityName": "abc123",
  "includesTime": true,
  "visibilityDisplayName": "abc123"
}
Types

DocumentTypeCustomFieldFuelEntryResponse

Fields
Field Name Description
autoExtract - Boolean
visibility - IdNameResponse
visibilityName - String
visibilityDisplayName - String
Example
{
  "autoExtract": false,
  "visibility": IdNameResponse,
  "visibilityName": "abc123",
  "visibilityDisplayName": "xyz789"
}
Types

DocumentTypeCustomFieldResponse

Fields
Field Name Description
autoExtract - IdNameResponse
prompt - String
visibility - IdNameResponse
visibilityName - String
visibilityDisplayName - String
Example
{
  "autoExtract": IdNameResponse,
  "prompt": "abc123",
  "visibility": IdNameResponse,
  "visibilityName": "xyz789",
  "visibilityDisplayName": "abc123"
}
Types

DocumentTypeCustomFieldsResponse

Fields
Field Name Description
location - DocumentTypeCustomFieldResponse!
currency - DocumentTypeCustomFieldResponse!
date - DocumentTypeCustomFieldDocumentDateResponse!
fuelEntry - DocumentTypeCustomFieldFuelEntryResponse!
referenceId - DocumentTypeCustomFieldResponse!
notes - DocumentTypeCustomFieldResponse!
fuelType - DocumentTypeCustomFieldResponse!
fuelVolume - DocumentTypeCustomFieldResponse!
totalCost - DocumentTypeCustomFieldResponse!
vendorName - DocumentTypeCustomFieldResponse!
odometer - DocumentTypeCustomFieldResponse!
loadNumber - DocumentTypeCustomFieldResponse!
vehicle - DocumentTypeCustomFieldResponse!
asset - DocumentTypeCustomFieldResponse!
driver - DocumentTypeCustomFieldResponse!
jurisdiction - DocumentTypeCustomFieldResponse!
driverLicense - DocumentTypeCustomFieldResponse!
expirationDate - DocumentTypeCustomFieldResponse!
invoiceNumber - DocumentTypeCustomFieldResponse!
paymentMethod - DocumentTypeCustomFieldResponse!
tollLocation - DocumentTypeCustomFieldResponse!
Example
{
  "location": DocumentTypeCustomFieldResponse,
  "currency": DocumentTypeCustomFieldResponse,
  "date": DocumentTypeCustomFieldDocumentDateResponse,
  "fuelEntry": DocumentTypeCustomFieldFuelEntryResponse,
  "referenceId": DocumentTypeCustomFieldResponse,
  "notes": DocumentTypeCustomFieldResponse,
  "fuelType": DocumentTypeCustomFieldResponse,
  "fuelVolume": DocumentTypeCustomFieldResponse,
  "totalCost": DocumentTypeCustomFieldResponse,
  "vendorName": DocumentTypeCustomFieldResponse,
  "odometer": DocumentTypeCustomFieldResponse,
  "loadNumber": DocumentTypeCustomFieldResponse,
  "vehicle": DocumentTypeCustomFieldResponse,
  "asset": DocumentTypeCustomFieldResponse,
  "driver": DocumentTypeCustomFieldResponse,
  "jurisdiction": DocumentTypeCustomFieldResponse,
  "driverLicense": DocumentTypeCustomFieldResponse,
  "expirationDate": DocumentTypeCustomFieldResponse,
  "invoiceNumber": DocumentTypeCustomFieldResponse,
  "paymentMethod": DocumentTypeCustomFieldResponse,
  "tollLocation": DocumentTypeCustomFieldResponse
}
Types

DocumentTypeFiltersRequest

Fields
Input Field Description
statuses - [DocumentTypeStatusRequest]
Example
{"statuses": [DocumentTypeStatusRequest]}
Types

DocumentTypeQuery

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

DocumentTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

DocumentTypeResponse

Fields
Field Name Description
name - String!
id - String!
access - IdNameResponse!
status - IdNameResponse!
createdAt - String!
updatedAt - String!
isSystem - Boolean!
customFields - DocumentTypeCustomFieldsResponse!
supportFileTypes - [IdNameResponse!]!
Example
{
  "name": "xyz789",
  "id": "xyz789",
  "access": IdNameResponse,
  "status": IdNameResponse,
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "isSystem": false,
  "customFields": DocumentTypeCustomFieldsResponse,
  "supportFileTypes": [IdNameResponse]
}
Types

DocumentTypeStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

DocumentTypesQuery

Fields
Input Field Description
terms - String
filters - DocumentTypeFiltersRequest
Example
{
  "terms": "xyz789",
  "filters": DocumentTypeFiltersRequest
}
Types

DocumentsQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
filters - DocumentFiltersRequest
sortBy - DocumentsSortByRequest
Example
{
  "terms": "abc123",
  "pagination": PaginationRequest,
  "filters": DocumentFiltersRequest,
  "sortBy": DocumentsSortByRequest
}
Types

DocumentsSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "abc123",
  "direction": "xyz789"
}
Types

DownloadDriversOverviewQuery

Fields
Input Field Description
fileType - DownloadFileTypeRequest
filters - DriversOverviewFiltersRequest
Example
{
  "fileType": DownloadFileTypeRequest,
  "filters": DriversOverviewFiltersRequest
}
Types

DownloadDriversWorkloadQuery

Fields
Input Field Description
fileType - DownloadFileTypeRequest
filters - DriversWorkloadFiltersRequest
Example
{
  "fileType": DownloadFileTypeRequest,
  "filters": DriversWorkloadFiltersRequest
}
Types

DownloadEmployeesOverviewQuery

Fields
Input Field Description
fileType - DownloadFileTypeRequest
filters - EmployeesOverviewFiltersRequest
Example
{
  "fileType": DownloadFileTypeRequest,
  "filters": EmployeesOverviewFiltersRequest
}
Types

DownloadFileTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

DriverCarrierRequest

Fields
Input Field Description
name - String
dotNumber - String
address - AddressRequest
Example
{
  "name": "xyz789",
  "dotNumber": "abc123",
  "address": AddressRequest
}
Types

DriverCarrierResponse

Fields
Field Name Description
name - String
address - AddressResponse!
dotNumber - String
Example
{
  "name": "abc123",
  "address": AddressResponse,
  "dotNumber": "xyz789"
}
Types

DriverQuery

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

DriverRequest

Fields
Input Field Description
id - String
firstName - String
lastName - String
Example
{
  "id": "abc123",
  "firstName": "xyz789",
  "lastName": "xyz789"
}
Types

DriverResponse

Fields
Field Name Description
id - String!
hos - HOSResponse
appDevice - AppDeviceResponse
groups - [ShortGroupResponse]
status - IdNameResponse!
username - String
carrier - DriverCarrierResponse
createdAt - String!
updatedAt - String
createdBy - ShortEmployeeResponse
photo - String
email - String
phone - String
company - IdNameResponse!
timezone - TimezoneResponse!
firstName - String!
lastName - String!
driverId - String
dutyStatus - IdNameResponse
logSettings - LogSettingsResponse
driverLicense - LicenseResponse
dutyStatusSetAt - String
lastAppSyncedAt - String
lastActiveAt - String
terminalAddress - AddressResponse
manualLocation - LocationResponse
calculatedLocation - LocationResponse
currentAssets - [EmbeddedAssetResponse]
currentVehicle - EmbeddedVehicleResponse
alertBeforeViolation - IdNameResponse
Example
{
  "id": "abc123",
  "hos": HOSResponse,
  "appDevice": AppDeviceResponse,
  "groups": [ShortGroupResponse],
  "status": IdNameResponse,
  "username": "abc123",
  "carrier": DriverCarrierResponse,
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "createdBy": ShortEmployeeResponse,
  "photo": "abc123",
  "email": "abc123",
  "phone": "xyz789",
  "company": IdNameResponse,
  "timezone": TimezoneResponse,
  "firstName": "abc123",
  "lastName": "abc123",
  "driverId": "xyz789",
  "dutyStatus": IdNameResponse,
  "logSettings": LogSettingsResponse,
  "driverLicense": LicenseResponse,
  "dutyStatusSetAt": "xyz789",
  "lastAppSyncedAt": "xyz789",
  "lastActiveAt": "abc123",
  "terminalAddress": AddressResponse,
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "currentAssets": [EmbeddedAssetResponse],
  "currentVehicle": EmbeddedVehicleResponse,
  "alertBeforeViolation": IdNameResponse
}
Types

DriverTripHistoryQuery

Fields
Input Field Description
id - String
filters - TripHistoryFiltersRequest
Example
{
  "id": "abc123",
  "filters": TripHistoryFiltersRequest
}
Types

DriverWorkloadResponse

Fields
Field Name Description
id - String
totalOnDuty - Int
firstName - String
lastName - String
driverId - String
totalOffDuty - Int
totalSleeper - Int
totalDriving - Int
totalTimeWorked - Int
totalDistance - Int
Example
{
  "id": "xyz789",
  "totalOnDuty": 987,
  "firstName": "abc123",
  "lastName": "abc123",
  "driverId": "abc123",
  "totalOffDuty": 987,
  "totalSleeper": 987,
  "totalDriving": 123,
  "totalTimeWorked": 987,
  "totalDistance": 123
}
Types

DriversFiltersRequest

Fields
Input Field Description
statuses - [EmployeeStatusRequest]
groups - [GroupRequest]
companies - [CompanyRequest]
Example
{
  "statuses": [EmployeeStatusRequest],
  "groups": [GroupRequest],
  "companies": [CompanyRequest]
}
Types

DriversOverviewFiltersRequest

Fields
Input Field Description
statuses - [EmployeeStatusRequest]
groups - [GroupRequest]
Example
{
  "statuses": [EmployeeStatusRequest],
  "groups": [GroupRequest]
}
Types

DriversQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
filters - DriversFiltersRequest
sortBy - DriversSortByRequest
Example
{
  "terms": "xyz789",
  "pagination": PaginationRequest,
  "filters": DriversFiltersRequest,
  "sortBy": DriversSortByRequest
}
Types

DriversSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "xyz789",
  "direction": "xyz789"
}
Types

DriversWorkloadFiltersRequest

Fields
Input Field Description
startDate - String
endDate - String
statuses - [EmployeeStatusRequest]
groups - [GroupRequest]
Example
{
  "startDate": "abc123",
  "endDate": "abc123",
  "statuses": [EmployeeStatusRequest],
  "groups": [GroupRequest]
}
Types

EldDeviceRequest

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

EmbeddedAssetResponse

Fields
Field Name Description
id - String!
number - String!
year - Int!
model - String!
make - String!
Example
{
  "id": "xyz789",
  "number": "xyz789",
  "year": 123,
  "model": "abc123",
  "make": "xyz789"
}
Types

EmbeddedDriverResponse

Fields
Field Name Description
id - String!
username - String!
firstName - String!
lastName - String!
driverId - String!
Example
{
  "id": "abc123",
  "username": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "driverId": "xyz789"
}
Types

EmbeddedEldDeviceResponse

Fields
Field Name Description
id - String!
macAddress - String!
model - IdNameResponse!
serialNumber - String!
Example
{
  "id": "abc123",
  "macAddress": "abc123",
  "model": IdNameResponse,
  "serialNumber": "xyz789"
}
Types

EmbeddedEmployeeResponse

Fields
Field Name Description
id - String!
username - String!
firstName - String!
lastName - String!
Example
{
  "id": "xyz789",
  "username": "abc123",
  "firstName": "abc123",
  "lastName": "xyz789"
}
Types

EmbeddedVehicleResponse

Description

Minimal vehicle details embedded inside other responses.

Fields
Field Name Description
id - String! Vehicle ID.
number - String! Fleet-assigned vehicle number.
year - Int! Model year.
vin - String! VIN.
model - String! Model name.
make - String! Manufacturer (make).
Example
{
  "id": "xyz789",
  "number": "abc123",
  "year": 123,
  "vin": "abc123",
  "model": "xyz789",
  "make": "xyz789"
}
Types

EmployeeFiltersRequest

Fields
Input Field Description
statuses - [EmployeeStatusRequest]
roles - [RoleRequest]
groups - [GroupRequest]
companies - [CompanyRequest]
Example
{
  "statuses": [EmployeeStatusRequest],
  "roles": [RoleRequest],
  "groups": [GroupRequest],
  "companies": [CompanyRequest]
}
Types

EmployeeQuery

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

EmployeeResponse

Fields
Field Name Description
groups - [ShortGroupResponse]
createdBy - ShortEmployeeResponse
phone - String
company - IdNameResponse!
lastActiveAt - String
id - String!
role - ShortRoleResponse!
status - IdNameResponse!
username - String
createdAt - String!
updatedAt - String!
photo - String
email - String
timezone - TimezoneResponse!
firstName - String!
lastName - String!
Example
{
  "groups": [ShortGroupResponse],
  "createdBy": ShortEmployeeResponse,
  "phone": "abc123",
  "company": IdNameResponse,
  "lastActiveAt": "xyz789",
  "id": "xyz789",
  "role": ShortRoleResponse,
  "status": IdNameResponse,
  "username": "xyz789",
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "photo": "abc123",
  "email": "abc123",
  "timezone": TimezoneResponse,
  "firstName": "abc123",
  "lastName": "abc123"
}
Types

EmployeeStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

EmployeesOverviewFiltersRequest

Fields
Input Field Description
statuses - [EmployeeStatusRequest]
groups - [GroupRequest]
Example
{
  "statuses": [EmployeeStatusRequest],
  "groups": [GroupRequest]
}
Types

EmployeesQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
filters - EmployeeFiltersRequest
sortBy - EmployeesSortByRequest
Example
{
  "terms": "abc123",
  "pagination": PaginationRequest,
  "filters": EmployeeFiltersRequest,
  "sortBy": EmployeesSortByRequest
}
Types

EmployeesSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "abc123",
  "direction": "xyz789"
}
Types

EventDurationResponse

Fields
Field Name Description
onDuty - Int!
driving - Int!
offDuty - Int!
sleeper - Int!
isOnDutyOngoing - Boolean!
isDrivingOngoing - Boolean!
isOffDutyOngoing - Boolean!
isSleeperOngoing - Boolean!
Example
{
  "onDuty": 123,
  "driving": 123,
  "offDuty": 987,
  "sleeper": 123,
  "isOnDutyOngoing": false,
  "isDrivingOngoing": true,
  "isOffDutyOngoing": true,
  "isSleeperOngoing": true
}
Types

FileDownloadUrlResponse

Fields
Field Name Description
url - String
Example
{"url": "xyz789"}
Types

FileUploadUrlResponse

Fields
Field Name Description
fileName - String
fileUploadUrl - String
Example
{
  "fileName": "xyz789",
  "fileUploadUrl": "xyz789"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

FmcsaReportResponse

Fields
Field Name Description
endTime - String!
startTime - String!
id - String
comment - String
driver - ShortDriverResponse
status - IdNameResponse
createdAt - String
processedTime - String!
Example
{
  "endTime": "abc123",
  "startTime": "xyz789",
  "id": "xyz789",
  "comment": "xyz789",
  "driver": ShortDriverResponse,
  "status": IdNameResponse,
  "createdAt": "abc123",
  "processedTime": "abc123"
}
Types

FuelTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

FuelVolumeRequest

Fields
Input Field Description
value - Int
unit - VolumeUnitRequest
Example
{"value": 123, "unit": VolumeUnitRequest}
Types

GenerateFileUploadUrlCommand

Fields
Input Field Description
fileType - String
Example
{"fileType": "xyz789"}
Types

GrossAxleMassUnitTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

GrossAxleWeightRequest

Fields
Input Field Description
value - Int
unit - GrossAxleMassUnitTypeRequest
Example
{"value": 123, "unit": GrossAxleMassUnitTypeRequest}
Types

GrossVehicleMassUnitTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

GrossVehicleWeightRequest

Fields
Input Field Description
value - Int
unit - GrossVehicleMassUnitTypeRequest
Example
{"value": 987, "unit": GrossVehicleMassUnitTypeRequest}
Types

GrossWeightResponse

Fields
Field Name Description
value - Int
unit - IdNameResponse
Example
{"value": 123, "unit": IdNameResponse}
Types

GroupRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

HOSResponse

Fields
Field Name Description
shift - Int
drive - Int
break - Int
cycle - Int
isCycleEnabled - Boolean!
isShiftEnabled - Boolean!
isBreakEnabled - Boolean!
isDriveEnabled - Boolean!
Example
{
  "shift": 987,
  "drive": 123,
  "break": 123,
  "cycle": 987,
  "isCycleEnabled": true,
  "isShiftEnabled": false,
  "isBreakEnabled": true,
  "isDriveEnabled": false
}
Types

IdNameResponse

Description

Generic ID–name pair used across the API.

Fields
Field Name Description
name - String!
id - String!
Example
{
  "name": "xyz789",
  "id": "abc123"
}
Types

IdRequest

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

InspectedPartResponse

Fields
Field Name Description
category - String
id - String!
type - IdNameResponse!
status - IdNameResponse!
createdAt - String!
updatedAt - String
createdBy - ShortEmployeeResponse!
defectType - IdNameResponse
resolvedBy - String
attachments - [AttachmentResponse]
reportedNote - String
resolvedNote - String
resolvedDate - String
Example
{
  "category": "abc123",
  "id": "xyz789",
  "type": IdNameResponse,
  "status": IdNameResponse,
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "createdBy": ShortEmployeeResponse,
  "defectType": IdNameResponse,
  "resolvedBy": "xyz789",
  "attachments": [AttachmentResponse],
  "reportedNote": "xyz789",
  "resolvedNote": "xyz789",
  "resolvedDate": "abc123"
}
Types

InspectedPartStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

InspectionFormRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

JurisdictionRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "abc123"
}
Types

LicenseRequest

Fields
Input Field Description
number - String
state - String
Example
{
  "number": "abc123",
  "state": "xyz789"
}
Types

LicenseResponse

Fields
Field Name Description
state - String!
number - String!
Example
{
  "state": "abc123",
  "number": "xyz789"
}
Types

ListedAssetResponse

Description

Compact representation of an asset used in list views.

Fields
Field Name Description
groups - [ShortGroupResponse!]! Groups assigned to this asset.
updatedBy - ShortEmployeeWithPhotoResponse! User who last updated this asset, including profile photo URL.
license - LicenseResponse Vehicle registration or license details.
manualLocation - LocationResponse Manually reported location.
calculatedLocation - LocationResponse Last GPS-calculated location.
inspectionForm - ShortInspectionFormResponse! Default inspection form for this asset.
currentDriver - EmbeddedDriverResponse Driver currently assigned to this asset, if any.
currentVehicle - EmbeddedVehicleResponse Vehicle currently paired with this asset.
id - String! Unique ID of the Asset (UUID).
type - IdNameResponse! Operational type (e.g. TRAILER, CHASSIS).
number - String! Fleet-wide asset / trailer number displayed on equipment.
year - Int Model year (e.g. 2024).
vin - String Vehicle Identification Number, if applicable.
status - IdNameResponse! Current lifecycle status of the asset.
createdAt - String! ISO-8601 timestamp when the asset was first created (UTC).
updatedAt - String! ISO-8601 timestamp for the last update (UTC).
createdBy - ShortEmployeeResponse! User that originally created the record.
model - String Model or series (if provided).
make - String Manufacturer (e.g. Wabash, Great Dane).
Example
{
  "groups": [ShortGroupResponse],
  "updatedBy": ShortEmployeeWithPhotoResponse,
  "license": LicenseResponse,
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "inspectionForm": ShortInspectionFormResponse,
  "currentDriver": EmbeddedDriverResponse,
  "currentVehicle": EmbeddedVehicleResponse,
  "id": "xyz789",
  "type": IdNameResponse,
  "number": "abc123",
  "year": 123,
  "vin": "abc123",
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "createdBy": ShortEmployeeResponse,
  "model": "xyz789",
  "make": "abc123"
}
Types

ListedDocumentResponse

Fields
Field Name Description
createdBy - ShortEmployeeWithPhotoResponse!
updatedBy - ShortEmployeeWithPhotoResponse!
sharedDrivers - [ShortDriverResponse!]!
sharedGroups - [ShortGroupResponse!]!
entities - DocumentEntitiesResponse
name - String!
id - String!
type - IdNameResponse!
number - Int!
date - String
referenceId - String
notes - String
status - IdNameResponse!
createdAt - String!
updatedAt - String!
Example
{
  "createdBy": ShortEmployeeWithPhotoResponse,
  "updatedBy": ShortEmployeeWithPhotoResponse,
  "sharedDrivers": [ShortDriverResponse],
  "sharedGroups": [ShortGroupResponse],
  "entities": DocumentEntitiesResponse,
  "name": "abc123",
  "id": "xyz789",
  "type": IdNameResponse,
  "number": 987,
  "date": "xyz789",
  "referenceId": "abc123",
  "notes": "abc123",
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "xyz789"
}
Types

ListedLogResponse

Fields
Field Name Description
violations - [ShortViolationResponse!]!
formAndManner - [ShortFormAndMannerResponse!]!
totalDistance - DistanceResponse!
totalDefects - Int!
eventDuration - EventDurationResponse!
totalInspectionReports - Int!
id - String!
date - String!
restBreak - IdNameResponse
driver - EmbeddedDriverResponse!
cargoType - IdNameResponse
restart - IdNameResponse
wellSite - IdNameResponse
carrier - DriverCarrierResponse!
vehicles - [EmbeddedVehicleResponse!]!
createdAt - String!
updatedAt - String!
assets - [EmbeddedAssetResponse!]!
utcEndTime - String!
timezone - TimezoneResponse!
cycle - IdNameResponse!
shortHaulException - IdNameResponse
weeklyHourLimit - IdNameResponse
cdlDriverType - IdNameResponse
terminalAddress - AddressResponse!
utcStartTime - String!
adverseConditionsException - IdNameResponse
Example
{
  "violations": [ShortViolationResponse],
  "formAndManner": [ShortFormAndMannerResponse],
  "totalDistance": DistanceResponse,
  "totalDefects": 123,
  "eventDuration": EventDurationResponse,
  "totalInspectionReports": 123,
  "id": "abc123",
  "date": "xyz789",
  "restBreak": IdNameResponse,
  "driver": EmbeddedDriverResponse,
  "cargoType": IdNameResponse,
  "restart": IdNameResponse,
  "wellSite": IdNameResponse,
  "carrier": DriverCarrierResponse,
  "vehicles": [EmbeddedVehicleResponse],
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "assets": [EmbeddedAssetResponse],
  "utcEndTime": "abc123",
  "timezone": TimezoneResponse,
  "cycle": IdNameResponse,
  "shortHaulException": IdNameResponse,
  "weeklyHourLimit": IdNameResponse,
  "cdlDriverType": IdNameResponse,
  "terminalAddress": AddressResponse,
  "utcStartTime": "abc123",
  "adverseConditionsException": IdNameResponse
}
Types

ListedMaintenanceResponse

Fields
Field Name Description
createdBy - ShortEmployeeWithPhotoResponse!
defectsNames - [String]
entity - MaintenanceEntityResponse!
id - String!
type - IdNameResponse!
number - Int!
odometer - Int
status - IdNameResponse!
createdAt - String!
updatedAt - String!
dateTime - String!
carrierName - String
Example
{
  "createdBy": ShortEmployeeWithPhotoResponse,
  "defectsNames": ["abc123"],
  "entity": MaintenanceEntityResponse,
  "id": "xyz789",
  "type": IdNameResponse,
  "number": 987,
  "odometer": 987,
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "dateTime": "xyz789",
  "carrierName": "abc123"
}
Types

ListedVehicleResponse

Fields
Field Name Description
groups - [ShortGroupResponse!]!
updatedBy - ShortEmployeeWithPhotoResponse!
id - String!
number - String!
year - Int!
vin - String
notes - String
fuelType - IdNameResponse!
odometer - IdNameResponse
status - IdNameResponse!
createdAt - String!
updatedAt - String!
eldDevice - ShortEldDeviceResponse
createdBy - ShortEmployeeResponse!
license - LicenseResponse
model - String!
make - String!
manualLocation - LocationResponse
calculatedLocation - LocationResponse
defectsCount - Int
inspectionForm - ShortInspectionFormResponse
currentDriver - EmbeddedDriverResponse
Example
{
  "groups": [ShortGroupResponse],
  "updatedBy": ShortEmployeeWithPhotoResponse,
  "id": "xyz789",
  "number": "xyz789",
  "year": 123,
  "vin": "abc123",
  "notes": "xyz789",
  "fuelType": IdNameResponse,
  "odometer": IdNameResponse,
  "status": IdNameResponse,
  "createdAt": "abc123",
  "updatedAt": "abc123",
  "eldDevice": ShortEldDeviceResponse,
  "createdBy": ShortEmployeeResponse,
  "license": LicenseResponse,
  "model": "xyz789",
  "make": "abc123",
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "defectsCount": 123,
  "inspectionForm": ShortInspectionFormResponse,
  "currentDriver": EmbeddedDriverResponse
}
Types

LiveEntityResponse

Fields
Field Name Description
description - String
name - String!
id - String!
type - IdNameResponse!
Example
{
  "description": "abc123",
  "name": "xyz789",
  "id": "abc123",
  "type": IdNameResponse
}
Types

LiveEntityTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "abc123"
}
Types

LiveFiltersRequest

Fields
Input Field Description
statuses - [LiveStatusRequest]
entityTypes - [LiveEntityTypeRequest]
groups - [GroupRequest]
Example
{
  "statuses": [LiveStatusRequest],
  "entityTypes": [LiveEntityTypeRequest],
  "groups": [GroupRequest]
}
Types

LiveQuery

Fields
Input Field Description
terms - String
filters - LiveFiltersRequest
Example
{
  "terms": "xyz789",
  "filters": LiveFiltersRequest
}
Types

LiveResponse

Fields
Field Name Description
entity - LiveEntityResponse!
id - String
odometer - OdometerResponse
speed - SpeedResponse
assetsIds - [String]
driverId - String
engineHours - Int
fuelEconomy - Int
fuelLevel - Int
manualLocation - LocationResponse
calculatedLocation - LocationResponse
entityStatus - IdNameResponse!
lastDutyStatusAt - String
lastCalculatedLocationAt - String
lastManualLocationAt - String
Example
{
  "entity": LiveEntityResponse,
  "id": "abc123",
  "odometer": OdometerResponse,
  "speed": SpeedResponse,
  "assetsIds": ["abc123"],
  "driverId": "abc123",
  "engineHours": 987,
  "fuelEconomy": 987,
  "fuelLevel": 123,
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "entityStatus": IdNameResponse,
  "lastDutyStatusAt": "xyz789",
  "lastCalculatedLocationAt": "xyz789",
  "lastManualLocationAt": "abc123"
}
Types

LiveStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

LocationResponse

Fields
Field Name Description
location - String!
latitude - Float!
longitude - Float!
Example
{
  "location": "xyz789",
  "latitude": 123.45,
  "longitude": 987.65
}
Types

LogCombinedStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

LogEventLocationResponse

Fields
Field Name Description
latitude - Float!
longitude - Float!
calculatedAddress - String!
Example
{
  "latitude": 987.65,
  "longitude": 987.65,
  "calculatedAddress": "abc123"
}
Types

LogEventResponse

Fields
Field Name Description
origin - IdNameResponse!
location - LogEventLocationResponse
id - String!
type - IdNameResponse!
time - String!
notes - String
vehicle - EmbeddedVehicleResponse
status - IdNameResponse!
sequenceId - String!
eldDevice - EmbeddedEldDeviceResponse
createdBy - EmbeddedEmployeeResponse!
updatedBy - EmbeddedEmployeeResponse
totalOdometer - Int
totalEngineHours - Int
certificationDate - String
malfunctionIndicatorStatus - IdNameResponse
malfunctionDiagnosticCode - IdNameResponse
diagnosticIndicatorStatus - IdNameResponse
Example
{
  "origin": IdNameResponse,
  "location": LogEventLocationResponse,
  "id": "xyz789",
  "type": IdNameResponse,
  "time": "abc123",
  "notes": "xyz789",
  "vehicle": EmbeddedVehicleResponse,
  "status": IdNameResponse,
  "sequenceId": "xyz789",
  "eldDevice": EmbeddedEldDeviceResponse,
  "createdBy": EmbeddedEmployeeResponse,
  "updatedBy": EmbeddedEmployeeResponse,
  "totalOdometer": 987,
  "totalEngineHours": 123,
  "certificationDate": "abc123",
  "malfunctionIndicatorStatus": IdNameResponse,
  "malfunctionDiagnosticCode": IdNameResponse,
  "diagnosticIndicatorStatus": IdNameResponse
}
Types

LogEventTypeResponse

Fields
Field Name Description
description - String
name - String
id - String
isDuty - Boolean
Example
{
  "description": "abc123",
  "name": "abc123",
  "id": "xyz789",
  "isDuty": false
}
Types

LogFiltersRequest

Fields
Input Field Description
startDate - String
endDate - String
driver - DriverRequest
drivers - [DriverRequest]
groups - [GroupRequest]
status - LogCombinedStatusRequest
Example
{
  "startDate": "xyz789",
  "endDate": "abc123",
  "driver": DriverRequest,
  "drivers": [DriverRequest],
  "groups": [GroupRequest],
  "status": LogCombinedStatusRequest
}
Types

LogIncrementTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

LogOdometerResponse

Fields
Field Name Description
end - Int!
distance - Int!
start - Int!
Example
{"end": 987, "distance": 987, "start": 123}
Types

LogQuery

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

LogResponse

Fields
Field Name Description
events - [LogEventResponse]
violations - [ViolationResponse]
suggestion - SuggestionResponse
odometers - [LogVehicleOdometerResponse]
coDrivers - [EmbeddedDriverResponse]
previousLog - NavigationLogResponse
nextLog - NavigationLogResponse
inspectionReports - [ShortMaintenanceResponse]
suggestionsHistory - [SuggestionResponse]
driverSignature - String
shippingDocuments - String
id - String!
date - String!
restBreak - IdNameResponse
driver - EmbeddedDriverResponse!
cargoType - IdNameResponse
restart - IdNameResponse
wellSite - IdNameResponse
carrier - DriverCarrierResponse!
vehicles - [EmbeddedVehicleResponse!]!
createdAt - String!
updatedAt - String!
assets - [EmbeddedAssetResponse!]!
utcEndTime - String!
timezone - TimezoneResponse!
cycle - IdNameResponse!
shortHaulException - IdNameResponse
weeklyHourLimit - IdNameResponse
cdlDriverType - IdNameResponse
terminalAddress - AddressResponse!
utcStartTime - String!
adverseConditionsException - IdNameResponse
Example
{
  "events": [LogEventResponse],
  "violations": [ViolationResponse],
  "suggestion": SuggestionResponse,
  "odometers": [LogVehicleOdometerResponse],
  "coDrivers": [EmbeddedDriverResponse],
  "previousLog": NavigationLogResponse,
  "nextLog": NavigationLogResponse,
  "inspectionReports": [ShortMaintenanceResponse],
  "suggestionsHistory": [SuggestionResponse],
  "driverSignature": "abc123",
  "shippingDocuments": "xyz789",
  "id": "abc123",
  "date": "xyz789",
  "restBreak": IdNameResponse,
  "driver": EmbeddedDriverResponse,
  "cargoType": IdNameResponse,
  "restart": IdNameResponse,
  "wellSite": IdNameResponse,
  "carrier": DriverCarrierResponse,
  "vehicles": [EmbeddedVehicleResponse],
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "assets": [EmbeddedAssetResponse],
  "utcEndTime": "abc123",
  "timezone": TimezoneResponse,
  "cycle": IdNameResponse,
  "shortHaulException": IdNameResponse,
  "weeklyHourLimit": IdNameResponse,
  "cdlDriverType": IdNameResponse,
  "terminalAddress": AddressResponse,
  "utcStartTime": "abc123",
  "adverseConditionsException": IdNameResponse
}
Types

LogSettingsRequest

Fields
Input Field Description
cycle - CycleRuleRequest
cargoType - CargoTypeRequest
restart - RestartTypeRequest
restBreak - RestBreakTypeRequest
shortHaulException - ShortHaulExceptionTypeRequest
adverseConditionsException - AdverseConditionsExceptionTypeRequest
weeklyHourLimit - WeeklyHourLimitTypeRequest
wellSite - WellSiteTypeRequest
cdlDriverType - CdlDriverTypeRequest
odometer - OdometerUnitRequest
logIncrement - LogIncrementTypeRequest
personalConveyance - PersonalConveyanceTypeRequest
yardMove - YardMoveTypeRequest
secondCycle - CycleRuleRequest
secondCargoType - CargoTypeRequest
secondRestart - RestartTypeRequest
secondRestBreak - RestBreakTypeRequest
secondShortHaulException - ShortHaulExceptionTypeRequest
secondAdverseConditionsException - AdverseConditionsExceptionTypeRequest
secondWeeklyHourLimit - WeeklyHourLimitTypeRequest
secondWellSite - WellSiteTypeRequest
secondCdlDriverType - CdlDriverTypeRequest
Example
{
  "cycle": CycleRuleRequest,
  "cargoType": CargoTypeRequest,
  "restart": RestartTypeRequest,
  "restBreak": RestBreakTypeRequest,
  "shortHaulException": ShortHaulExceptionTypeRequest,
  "adverseConditionsException": AdverseConditionsExceptionTypeRequest,
  "weeklyHourLimit": WeeklyHourLimitTypeRequest,
  "wellSite": WellSiteTypeRequest,
  "cdlDriverType": CdlDriverTypeRequest,
  "odometer": OdometerUnitRequest,
  "logIncrement": LogIncrementTypeRequest,
  "personalConveyance": PersonalConveyanceTypeRequest,
  "yardMove": YardMoveTypeRequest,
  "secondCycle": CycleRuleRequest,
  "secondCargoType": CargoTypeRequest,
  "secondRestart": RestartTypeRequest,
  "secondRestBreak": RestBreakTypeRequest,
  "secondShortHaulException": ShortHaulExceptionTypeRequest,
  "secondAdverseConditionsException": AdverseConditionsExceptionTypeRequest,
  "secondWeeklyHourLimit": WeeklyHourLimitTypeRequest,
  "secondWellSite": WellSiteTypeRequest,
  "secondCdlDriverType": CdlDriverTypeRequest
}
Types

LogSettingsResponse

Description

Driver log-book configuration settings at the company level.

Fields
Field Name Description
restBreak - IdNameResponse Mandatory rest-break configuration.
odometer - IdNameResponse! Odometer tracking method.
cargoType - IdNameResponse Primary cargo type, if set.
restart - IdNameResponse 34-hour restart option.
wellSite - IdNameResponse Well-site exception flag.
yardMove - IdNameResponse! Yard-move availability setting.
secondCycle - IdNameResponse Secondary cycle rule.
cycle - IdNameResponse! Primary cycle rule for drivers.
secondRestBreak - IdNameResponse Secondary rest-break configuration.
shortHaulException - IdNameResponse Short-haul exception setting.
weeklyHourLimit - IdNameResponse Weekly hour limit setting.
cdlDriverType - IdNameResponse CDL driver type rule.
logIncrement - IdNameResponse Log increment granularity.
personalConveyance - IdNameResponse! Personal conveyance availability setting.
secondCargoType - IdNameResponse Secondary cargo type.
secondRestart - IdNameResponse Secondary 34-hour restart option.
secondCdlDriverType - IdNameResponse Secondary CDL driver type.
secondWellSite - IdNameResponse Secondary well-site exception.
adverseConditionsException - IdNameResponse Adverse driving conditions exception.
secondShortHaulException - IdNameResponse Secondary short-haul exception.
secondWeeklyHourLimit - IdNameResponse Secondary weekly hour limit.
secondAdverseConditionsException - IdNameResponse Secondary adverse conditions exception.
Example
{
  "restBreak": IdNameResponse,
  "odometer": IdNameResponse,
  "cargoType": IdNameResponse,
  "restart": IdNameResponse,
  "wellSite": IdNameResponse,
  "yardMove": IdNameResponse,
  "secondCycle": IdNameResponse,
  "cycle": IdNameResponse,
  "secondRestBreak": IdNameResponse,
  "shortHaulException": IdNameResponse,
  "weeklyHourLimit": IdNameResponse,
  "cdlDriverType": IdNameResponse,
  "logIncrement": IdNameResponse,
  "personalConveyance": IdNameResponse,
  "secondCargoType": IdNameResponse,
  "secondRestart": IdNameResponse,
  "secondCdlDriverType": IdNameResponse,
  "secondWellSite": IdNameResponse,
  "adverseConditionsException": IdNameResponse,
  "secondShortHaulException": IdNameResponse,
  "secondWeeklyHourLimit": IdNameResponse,
  "secondAdverseConditionsException": IdNameResponse
}
Types

LogVehicleOdometerResponse

Fields
Field Name Description
vehicle - EmbeddedVehicleResponse!
odometers - [LogOdometerResponse!]!
Example
{
  "vehicle": EmbeddedVehicleResponse,
  "odometers": [LogOdometerResponse]
}
Types

LogsQuery

Fields
Input Field Description
filters - LogFiltersRequest
pagination - PaginationRequest
sortBy - LogsSortByRequest
Example
{
  "filters": LogFiltersRequest,
  "pagination": PaginationRequest,
  "sortBy": LogsSortByRequest
}
Types

LogsSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "abc123",
  "direction": "xyz789"
}
Types

MaintenanceCombinedStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

MaintenanceEntityResponse

Fields
Field Name Description
name - String
id - String!
type - IdNameResponse!
Example
{
  "name": "abc123",
  "id": "abc123",
  "type": IdNameResponse
}
Types

MaintenanceFiltersRequest

Fields
Input Field Description
startDate - String
endDate - String
groups - [GroupRequest]
vehicles - [VehicleRequest]
assets - [AssetRequest]
drivers - [DriverRequest]
status - MaintenanceCombinedStatusRequest
type - MaintenanceTypeRequest
Example
{
  "startDate": "abc123",
  "endDate": "xyz789",
  "groups": [GroupRequest],
  "vehicles": [VehicleRequest],
  "assets": [AssetRequest],
  "drivers": [DriverRequest],
  "status": MaintenanceCombinedStatusRequest,
  "type": MaintenanceTypeRequest
}
Types

MaintenanceQuery

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

MaintenanceResponse

Fields
Field Name Description
createdBy - ShortEmployeeResponse!
driverSignature - String
inspectedParts - [InspectedPartResponse]
entity - MaintenanceEntityResponse!
id - String!
type - IdNameResponse!
number - Int!
odometer - Int
status - IdNameResponse!
createdAt - String!
updatedAt - String!
dateTime - String!
carrierName - String
Example
{
  "createdBy": ShortEmployeeResponse,
  "driverSignature": "abc123",
  "inspectedParts": [InspectedPartResponse],
  "entity": MaintenanceEntityResponse,
  "id": "xyz789",
  "type": IdNameResponse,
  "number": 987,
  "odometer": 123,
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "dateTime": "abc123",
  "carrierName": "xyz789"
}
Types

MaintenanceTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

MaintenancesQuery

Fields
Input Field Description
pagination - PaginationRequest
filters - MaintenanceFiltersRequest
sortBy - MaintenancesSortByRequest
Example
{
  "pagination": PaginationRequest,
  "filters": MaintenanceFiltersRequest,
  "sortBy": MaintenancesSortByRequest
}
Types

MaintenancesSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "xyz789",
  "direction": "abc123"
}
Types

NavigationLogResponse

Fields
Field Name Description
id - String!
date - String!
utcEndTime - String!
utcStartTime - String!
Example
{
  "id": "xyz789",
  "date": "xyz789",
  "utcEndTime": "abc123",
  "utcStartTime": "xyz789"
}
Types

OdometerRequest

Fields
Input Field Description
value - Int
unit - OdometerUnitRequest
Example
{"value": 123, "unit": OdometerUnitRequest}
Types

OdometerResponse

Fields
Field Name Description
value - Int!
unit - OdometerUnitResponse!
Example
{"value": 987, "unit": OdometerUnitResponse}
Types

OdometerUnitRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

OdometerUnitResponse

Fields
Field Name Description
name - String!
id - String!
shortName - String!
Example
{
  "name": "abc123",
  "id": "xyz789",
  "shortName": "abc123"
}
Types

OwnershipRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

PaginatedAssetsResponse

Description

Paginated list of assets with pagination metadata.

Fields
Field Name Description
pagination - PaginationResponse! Pagination details for the current page.
assets - [ListedAssetResponse!]! List of assets for this page.
Example
{
  "pagination": PaginationResponse,
  "assets": [ListedAssetResponse]
}
Types

PaginatedDocumentsResponse

Fields
Field Name Description
pagination - PaginationResponse
documents - [ListedDocumentResponse]
Example
{
  "pagination": PaginationResponse,
  "documents": [ListedDocumentResponse]
}
Types

PaginatedDriversResponse

Fields
Field Name Description
pagination - PaginationResponse
drivers - [DriverResponse]
Example
{
  "pagination": PaginationResponse,
  "drivers": [DriverResponse]
}
Types

PaginatedDriversWorkloadResponse

Fields
Field Name Description
pagination - PaginationResponse
drivers - [DriverWorkloadResponse]
Example
{
  "pagination": PaginationResponse,
  "drivers": [DriverWorkloadResponse]
}
Types

PaginatedEmployeesResponse

Fields
Field Name Description
pagination - PaginationResponse!
employees - [EmployeeResponse!]!
Example
{
  "pagination": PaginationResponse,
  "employees": [EmployeeResponse]
}
Types

PaginatedFmcsaReportsResponse

Fields
Field Name Description
pagination - PaginationResponse
fmcsaReports - [FmcsaReportResponse]
Example
{
  "pagination": PaginationResponse,
  "fmcsaReports": [FmcsaReportResponse]
}
Types

PaginatedLogsResponse

Fields
Field Name Description
pagination - PaginationResponse
logs - [ListedLogResponse]
Example
{
  "pagination": PaginationResponse,
  "logs": [ListedLogResponse]
}
Types

PaginatedMaintenancesResponse

Fields
Field Name Description
pagination - PaginationResponse
maintenances - [ListedMaintenanceResponse]
Example
{
  "pagination": PaginationResponse,
  "maintenances": [ListedMaintenanceResponse]
}
Types

PaginatedVehiclesResponse

Fields
Field Name Description
pagination - PaginationResponse!
vehicles - [ListedVehicleResponse!]!
Example
{
  "pagination": PaginationResponse,
  "vehicles": [ListedVehicleResponse]
}
Types

PaginatedViolationsResponse

Fields
Field Name Description
pagination - PaginationResponse
violations - [ViolationResponse]
Example
{
  "pagination": PaginationResponse,
  "violations": [ViolationResponse]
}
Types

PaginationRequest

Description

Simple wrapper for page number and items per page.

Fields
Input Field Description
pageNumber - Int Page number to return (defaults to 1).
itemsPerPage - Int Number of items per page (defaults to 100).
Example
{"pageNumber": 123, "itemsPerPage": 123}
Types

PaginationResponse

Fields
Field Name Description
itemsOnPage - Int
totalItems - Int
pageNumber - Int
totalPages - Int
itemsPerPage - Int
Example
{
  "itemsOnPage": 987,
  "totalItems": 987,
  "pageNumber": 123,
  "totalPages": 123,
  "itemsPerPage": 123
}
Types

PaymentMethodRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

PersonalConveyanceTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "abc123"
}
Types

ReopenInspectedPartCommand

Fields
Input Field Description
id - String
Example
{"id": "xyz789"}
Types

ReportDriversOverviewQuery

Fields
Input Field Description
pagination - PaginationRequest
filters - DriversOverviewFiltersRequest
Example
{
  "pagination": PaginationRequest,
  "filters": DriversOverviewFiltersRequest
}
Types

ReportDriversWorkloadQuery

Fields
Input Field Description
pagination - PaginationRequest
filters - DriversWorkloadFiltersRequest
Example
{
  "pagination": PaginationRequest,
  "filters": DriversWorkloadFiltersRequest
}
Types

ReportEmployeesOverviewQuery

Fields
Input Field Description
pagination - PaginationRequest
filters - EmployeesOverviewFiltersRequest
Example
{
  "pagination": PaginationRequest,
  "filters": EmployeesOverviewFiltersRequest
}
Types

ReportFmcsaQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
Example
{
  "terms": "xyz789",
  "pagination": PaginationRequest
}
Types

ReportHosRecapQuery

Fields
Input Field Description
pagination - PaginationRequest
filters - DriversWorkloadFiltersRequest
Example
{
  "pagination": PaginationRequest,
  "filters": DriversWorkloadFiltersRequest
}
Types

ResolveInspectedPartCommand

Fields
Input Field Description
id - String
resolvedBy - String
status - InspectedPartStatusRequest
date - String
note - String
Example
{
  "id": "abc123",
  "resolvedBy": "abc123",
  "status": InspectedPartStatusRequest,
  "date": "abc123",
  "note": "abc123"
}
Types

RestBreakTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

RestartTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

RestoreDocumentCommand

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

RoleRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

ShareDocumentCommand

Fields
Input Field Description
id - String
sharedDrivers - [DriverRequest]
sharedGroups - [GroupRequest]
Example
{
  "id": "xyz789",
  "sharedDrivers": [DriverRequest],
  "sharedGroups": [GroupRequest]
}
Types

SharedLocationResponse

Fields
Field Name Description
id - String!
createdAt - String!
updatedAt - String!
expiresAt - String!
isDriverPhoneNumberVisible - Boolean!
isShippingDocumentsVisible - Boolean!
isDriverDutyStatusVisible - Boolean!
Example
{
  "id": "xyz789",
  "createdAt": "abc123",
  "updatedAt": "abc123",
  "expiresAt": "abc123",
  "isDriverPhoneNumberVisible": false,
  "isShippingDocumentsVisible": false,
  "isDriverDutyStatusVisible": false
}
Types

SharedLocationsQuery

Fields
Input Field Description
vehicleId - String
Example
{"vehicleId": "xyz789"}
Types

ShortDriverResponse

Fields
Field Name Description
id - String!
status - IdNameResponse!
username - String!
firstName - String!
lastName - String!
driverId - String!
Example
{
  "id": "abc123",
  "status": IdNameResponse,
  "username": "abc123",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "driverId": "abc123"
}
Types

ShortEldDeviceResponse

Fields
Field Name Description
name - String!
id - String!
macAddress - String!
model - IdNameResponse!
serialNumber - String!
Example
{
  "name": "abc123",
  "id": "abc123",
  "macAddress": "abc123",
  "model": IdNameResponse,
  "serialNumber": "xyz789"
}
Types

ShortEmployeeResponse

Fields
Field Name Description
id - String!
status - IdNameResponse!
firstName - String!
lastName - String!
Example
{
  "id": "abc123",
  "status": IdNameResponse,
  "firstName": "abc123",
  "lastName": "xyz789"
}
Types

ShortEmployeeWithPhotoResponse

Fields
Field Name Description
id - String!
role - ShortRoleResponse!
status - IdNameResponse!
photo - String
firstName - String!
lastName - String!
Example
{
  "id": "xyz789",
  "role": ShortRoleResponse,
  "status": IdNameResponse,
  "photo": "abc123",
  "firstName": "abc123",
  "lastName": "abc123"
}
Types

ShortFormAndMannerResponse

Fields
Field Name Description
type - IdNameResponse!
Example
{"type": IdNameResponse}
Types

ShortGroupResponse

Fields
Field Name Description
name - String
id - String
Example
{
  "name": "xyz789",
  "id": "abc123"
}
Types

ShortHaulExceptionTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

ShortInspectionFormResponse

Fields
Field Name Description
name - String
id - String
Example
{
  "name": "abc123",
  "id": "xyz789"
}
Types

ShortMaintenanceResponse

Fields
Field Name Description
entity - MaintenanceEntityResponse
id - String
type - IdNameResponse
odometer - Int
dateTime - String
carrierName - String
defectsNames - [String]
Example
{
  "entity": MaintenanceEntityResponse,
  "id": "abc123",
  "type": IdNameResponse,
  "odometer": 123,
  "dateTime": "abc123",
  "carrierName": "xyz789",
  "defectsNames": ["abc123"]
}
Types

ShortRoleResponse

Fields
Field Name Description
name - String!
id - String!
Example
{
  "name": "abc123",
  "id": "abc123"
}
Types

ShortViolationResponse

Fields
Field Name Description
type - IdNameResponse!
Example
{"type": IdNameResponse}
Types

SpeedResponse

Fields
Field Name Description
value - Int!
unit - SpeedUnitResponse!
Example
{"value": 123, "unit": SpeedUnitResponse}
Types

SpeedUnitResponse

Fields
Field Name Description
name - String!
id - String!
shortName - String!
Example
{
  "name": "xyz789",
  "id": "abc123",
  "shortName": "abc123"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

SucceedResponse

Fields
Field Name Description
status - Boolean
Example
{"status": true}
Types

SuggestionEventResponse

Fields
Field Name Description
operation - IdNameResponse!
endTime - String!
startTime - String!
id - String!
type - IdNameResponse!
notes - String!
manualLocation - String
Example
{
  "operation": IdNameResponse,
  "endTime": "xyz789",
  "startTime": "xyz789",
  "id": "abc123",
  "type": IdNameResponse,
  "notes": "xyz789",
  "manualLocation": "xyz789"
}
Types

SuggestionResponse

Fields
Field Name Description
events - [SuggestionEventResponse!]!
id - String!
status - IdNameResponse!
carrier - DriverCarrierResponse!
vehicles - [EmbeddedVehicleResponse!]!
coDrivers - [EmbeddedDriverResponse!]!
createdAt - String!
createdBy - EmbeddedEmployeeResponse!
deletedBy - EmbeddedEmployeeResponse
approvedBy - EmbeddedEmployeeResponse
deletedAt - String
approvedAt - String
assets - [EmbeddedAssetResponse!]!
terminalAddress - AddressResponse
shippingDocuments - String!
changedFields - [String!]!
Example
{
  "events": [SuggestionEventResponse],
  "id": "abc123",
  "status": IdNameResponse,
  "carrier": DriverCarrierResponse,
  "vehicles": [EmbeddedVehicleResponse],
  "coDrivers": [EmbeddedDriverResponse],
  "createdAt": "xyz789",
  "createdBy": EmbeddedEmployeeResponse,
  "deletedBy": EmbeddedEmployeeResponse,
  "approvedBy": EmbeddedEmployeeResponse,
  "deletedAt": "abc123",
  "approvedAt": "abc123",
  "assets": [EmbeddedAssetResponse],
  "terminalAddress": AddressResponse,
  "shippingDocuments": "xyz789",
  "changedFields": ["abc123"]
}
Types

TimezoneRequest

Fields
Input Field Description
id - String
code - String
name - String
Example
{
  "id": "xyz789",
  "code": "abc123",
  "name": "abc123"
}
Types

TimezoneResponse

Description

Simple timezone object with ID, code, and human-readable name.

Fields
Field Name Description
name - String!
id - String!
code - String!
Example
{
  "name": "xyz789",
  "id": "xyz789",
  "code": "xyz789"
}
Types

TotalCostRequest

Fields
Input Field Description
value - Int
unit - CurrencyRequest
Example
{"value": 987, "unit": CurrencyRequest}
Types

TripHistoryFiltersRequest

Fields
Input Field Description
date - String
Example
{"date": "xyz789"}
Types

TripPointResponse

Fields
Field Name Description
location - LocationResponse
id - String!
state - String
odometer - OdometerResponse
vehicle - EmbeddedVehicleResponse
driver - EmbeddedDriverResponse
status - IdNameResponse
createdAt - String
speed - SpeedResponse
engineHours - Int
fuelEconomy - Int
fuelLevel - Int
Example
{
  "location": LocationResponse,
  "id": "abc123",
  "state": "abc123",
  "odometer": OdometerResponse,
  "vehicle": EmbeddedVehicleResponse,
  "driver": EmbeddedDriverResponse,
  "status": IdNameResponse,
  "createdAt": "abc123",
  "speed": SpeedResponse,
  "engineHours": 123,
  "fuelEconomy": 123,
  "fuelLevel": 123
}
Types

UpdateAssetCommand

Fields
Input Field Description
id - String
number - String
vin - String
year - Int
make - String
model - String
type - AssetTypeRequest
inspectionForm - InspectionFormRequest
license - LicenseRequest
notes - String
groups - [GroupRequest]
length - AssetLengthRequest
gvwr - GrossVehicleWeightRequest
gawr - GrossAxleWeightRequest
axles - Int
ownership - OwnershipRequest
status - AssetStatusRequest
Example
{
  "id": "xyz789",
  "number": "abc123",
  "vin": "xyz789",
  "year": 123,
  "make": "xyz789",
  "model": "xyz789",
  "type": AssetTypeRequest,
  "inspectionForm": InspectionFormRequest,
  "license": LicenseRequest,
  "notes": "xyz789",
  "groups": [GroupRequest],
  "length": AssetLengthRequest,
  "gvwr": GrossVehicleWeightRequest,
  "gawr": GrossAxleWeightRequest,
  "axles": 123,
  "ownership": OwnershipRequest,
  "status": AssetStatusRequest
}
Types

UpdateDocumentCommand

Fields
Input Field Description
id - String
attachments - [AttachmentRequest]
date - String
referenceId - String
notes - String
jurisdiction - JurisdictionRequest
fuelType - FuelTypeRequest
fuelVolume - FuelVolumeRequest
totalCost - TotalCostRequest
vendorName - String
location - String
odometer - OdometerRequest
driverLicense - String
expirationDate - String
invoiceNumber - String
loadNumber - String
paymentMethod - PaymentMethodRequest
currency - CurrencyRequest
tollLocation - String
vehicle - VehicleRequest
asset - AssetRequest
driver - DriverRequest
Example
{
  "id": "xyz789",
  "attachments": [AttachmentRequest],
  "date": "xyz789",
  "referenceId": "xyz789",
  "notes": "xyz789",
  "jurisdiction": JurisdictionRequest,
  "fuelType": FuelTypeRequest,
  "fuelVolume": FuelVolumeRequest,
  "totalCost": TotalCostRequest,
  "vendorName": "abc123",
  "location": "abc123",
  "odometer": OdometerRequest,
  "driverLicense": "abc123",
  "expirationDate": "abc123",
  "invoiceNumber": "abc123",
  "loadNumber": "xyz789",
  "paymentMethod": PaymentMethodRequest,
  "currency": CurrencyRequest,
  "tollLocation": "abc123",
  "vehicle": VehicleRequest,
  "asset": AssetRequest,
  "driver": DriverRequest
}
Types

UpdateDriverCommand

Fields
Input Field Description
id - String
firstName - String
lastName - String
phone - String
driverId - String
email - String
username - String
password - String
groups - [GroupRequest]
driverLicense - LicenseRequest
carrier - DriverCarrierRequest
terminalAddress - AddressRequest
alertBeforeViolation - AlertBeforeViolationRequest
timezone - TimezoneRequest
logSettings - LogSettingsRequest
Example
{
  "id": "abc123",
  "firstName": "abc123",
  "lastName": "xyz789",
  "phone": "xyz789",
  "driverId": "xyz789",
  "email": "xyz789",
  "username": "abc123",
  "password": "xyz789",
  "groups": [GroupRequest],
  "driverLicense": LicenseRequest,
  "carrier": DriverCarrierRequest,
  "terminalAddress": AddressRequest,
  "alertBeforeViolation": AlertBeforeViolationRequest,
  "timezone": TimezoneRequest,
  "logSettings": LogSettingsRequest
}
Types

UpdateVehicleCommand

Fields
Input Field Description
id - String
number - String
vin - String
year - Int
make - String
model - String
license - LicenseRequest
odometer - OdometerUnitRequest
notes - String
fuelType - FuelTypeRequest
inspectionForm - InspectionFormRequest
groups - [GroupRequest]
eldDevice - EldDeviceRequest
Example
{
  "id": "abc123",
  "number": "xyz789",
  "vin": "abc123",
  "year": 123,
  "make": "abc123",
  "model": "abc123",
  "license": LicenseRequest,
  "odometer": OdometerUnitRequest,
  "notes": "xyz789",
  "fuelType": FuelTypeRequest,
  "inspectionForm": InspectionFormRequest,
  "groups": [GroupRequest],
  "eldDevice": EldDeviceRequest
}
Types

VehicleFiltersRequest

Fields
Input Field Description
statuses - [VehicleStatusRequest]
groups - [GroupRequest]
currentDrivers - [DriverRequest]
Example
{
  "statuses": [VehicleStatusRequest],
  "groups": [GroupRequest],
  "currentDrivers": [DriverRequest]
}
Types

VehicleQuery

Fields
Input Field Description
id - String
Example
{"id": "abc123"}
Types

VehicleRequest

Fields
Input Field Description
id - String
number - String
name - String
Example
{
  "id": "xyz789",
  "number": "abc123",
  "name": "abc123"
}
Types

VehicleResponse

Fields
Field Name Description
groups - [ShortGroupResponse!]!
updatedBy - ShortEmployeeResponse!
id - String!
number - String!
year - Int!
vin - String
notes - String
fuelType - IdNameResponse!
odometer - IdNameResponse
status - IdNameResponse!
createdAt - String!
updatedAt - String!
eldDevice - ShortEldDeviceResponse
createdBy - ShortEmployeeResponse!
license - LicenseResponse
model - String!
make - String!
manualLocation - LocationResponse
calculatedLocation - LocationResponse
defectsCount - Int
inspectionForm - ShortInspectionFormResponse
currentDriver - EmbeddedDriverResponse
Example
{
  "groups": [ShortGroupResponse],
  "updatedBy": ShortEmployeeResponse,
  "id": "abc123",
  "number": "xyz789",
  "year": 123,
  "vin": "xyz789",
  "notes": "xyz789",
  "fuelType": IdNameResponse,
  "odometer": IdNameResponse,
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "eldDevice": ShortEldDeviceResponse,
  "createdBy": ShortEmployeeResponse,
  "license": LicenseResponse,
  "model": "abc123",
  "make": "abc123",
  "manualLocation": LocationResponse,
  "calculatedLocation": LocationResponse,
  "defectsCount": 123,
  "inspectionForm": ShortInspectionFormResponse,
  "currentDriver": EmbeddedDriverResponse
}
Types

VehicleStatusRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

VehicleTripHistoryQuery

Fields
Input Field Description
id - String
filters - TripHistoryFiltersRequest
Example
{
  "id": "xyz789",
  "filters": TripHistoryFiltersRequest
}
Types

VehiclesQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
filters - VehicleFiltersRequest
sortBy - VehiclesSortByRequest
Example
{
  "terms": "abc123",
  "pagination": PaginationRequest,
  "filters": VehicleFiltersRequest,
  "sortBy": VehiclesSortByRequest
}
Types

VehiclesSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "abc123",
  "direction": "xyz789"
}
Types

ViolationFiltersRequest

Fields
Input Field Description
driver - DriverRequest
Example
{"driver": DriverRequest}
Types

ViolationResponse

Fields
Field Name Description
endTime - String
startTime - String!
id - String!
type - IdNameResponse!
driver - EmbeddedDriverResponse!
status - IdNameResponse!
createdAt - String!
updatedAt - String
Example
{
  "endTime": "xyz789",
  "startTime": "abc123",
  "id": "abc123",
  "type": IdNameResponse,
  "driver": EmbeddedDriverResponse,
  "status": IdNameResponse,
  "createdAt": "xyz789",
  "updatedAt": "abc123"
}
Types

ViolationsQuery

Fields
Input Field Description
terms - String
pagination - PaginationRequest
filters - ViolationFiltersRequest
sortBy - ViolationsSortByRequest
Example
{
  "terms": "xyz789",
  "pagination": PaginationRequest,
  "filters": ViolationFiltersRequest,
  "sortBy": ViolationsSortByRequest
}
Types

ViolationsSortByRequest

Fields
Input Field Description
name - String
direction - String
Example
{
  "name": "abc123",
  "direction": "abc123"
}
Types

VolumeUnitRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "abc123",
  "name": "xyz789"
}
Types

WeeklyHourLimitTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

WellSiteTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "xyz789"
}
Types

YardMoveTypeRequest

Fields
Input Field Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Documentation by Anvil SpectaQL