MileIQ

App · 6 actions

Read your MileIQ profile, drives, teams and reported mileage.

Actions

ActionWhat it does
Get Current User ProfileGet your MileIQ profile, including personal details, contact information and account status.
Get Group by IDGet a team by its ID.
Get Group Reported DrivesList the drives a team's members have reported for review, most recently changed first, with driver and review details.
Get GroupsList the teams you are an administrator of.
Get User by IDGet a user's profile by their ID.
Get User DrivesList a user's drives, most recently changed first, with locations, distance, value and other details.

Get Current User Profile

Get your MileIQ profile, including personal details, contact information and account status.

Inputs

None.

Outputs

Value.

dataobject
Complete user profile information including identity, contact details, and account status
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "active": false,
    "displayName": "example",
    "emails": [
      {
        "primary": false,
        "type": "example",
        "value": "example"
      }
    ],
    "id": "example",
    "name": {
      "familyName": "example",
      "formatted": "example",
      "givenName": "example"
    },
    "userName": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get Group by ID

Get a team by its ID. You must be an administrator of the team.

Inputs

Groupgroup_idnumberRequired
Group id.

Outputs

Value.

dataobject
Response model containing a collection of groups with their complete information and member details
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "resources": [
      {
        "display_name": "example",
        "id": "example",
        "members": [
          {
            "display": "example",
            "is_admin": false,
            "is_driver": false,
            "value": "example"
          }
        ],
        "meta": {
          "created": "2026-10-01T12:00:00Z",
          "lastModified": "2026-10-01T12:00:00Z",
          "location": "example",
          "resourceType": "example"
        }
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

Get Group Reported Drives

List the drives a team's members have reported for review, most recently changed first, with driver and review details. You can filter by date range. A drive's created time is when it was reported; its start and end times are when it happened.

Inputs

Groupgroup_idtextRequired
Group id.
Limitlimitnumber
The number of drives to retrieveFrom 1 to 1000.
Date beforedate_beforedate and time
The end date of the range to retrieve drives for based on the defined filter_by param (exclusive). Filter_by needs to be set for this field to be used. Should be in UTC
Date afterdate_afterdate and time
The start date of the range to retrieve drives for based on the defined filter_by param (exclusive). Filter_by needs to be set for this field to be used. Should be in UTC
Filter byfilter_bytext
Use 'ended' to filter by the date the drive has ended. Use 'modified' to filter by the date the drive was last updatedOne of: modified, ended.

Outputs

Value.

dataobject
The API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "has_more": false,
    "results": [
      {
        "created": "2026-10-01T12:00:00Z",
        "details": {
          "classification": {},
          "description": "example",
          "distance": {},
          "end": {},
          "entry": "manual",
          "parking_fees": {},
          "purpose": "example",
          "start": {},
          "toll_fees": {},
          "value": {}
        },
        "driver": {
          "email": "example",
          "id": "example",
          "name": "example",
          "status": "example",
          "timezone_offset": 1
        },
        "id": "example",
        "modified": "2026-10-01T12:00:00Z",
        "review_comments": [
          {
            "created_at": "2026-10-01T12:00:00Z",
            "id": "example",
            "text": "example",
            "user_email": "example"
          }
        ],
        "status": "example"
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

Get Groups

List the teams you are an administrator of.

Inputs

None.

Outputs

Value.

dataobject
Response model containing a collection of groups with their complete information and member details
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "resources": [
      {
        "display_name": "example",
        "id": "example",
        "members": [
          {
            "display": "example",
            "is_admin": false,
            "is_driver": false,
            "value": "example"
          }
        ],
        "meta": {
          "created": "2026-10-01T12:00:00Z",
          "lastModified": "2026-10-01T12:00:00Z",
          "location": "example",
          "resourceType": "example"
        }
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

Get User by ID

Get a user's profile by their ID. You can only see your own profile.

Inputs

Personperson_idtextRequired
Your MileIQ user. Select your connected profile or enter its ID.

Outputs

Value.

dataobject
Complete user profile information including identity, contact details, and account status
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "active": false,
    "displayName": "example",
    "emails": [
      {
        "primary": false,
        "type": "example",
        "value": "example"
      }
    ],
    "id": "example",
    "name": {
      "familyName": "example",
      "formatted": "example",
      "givenName": "example"
    },
    "userName": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Get User Drives

List a user's drives, most recently changed first, with locations, distance, value and other details. You can filter by business or personal drives and by date range, and you can only see your own drives. A drive's created time is when it was recorded; its start and end times are when it happened.

Inputs

Personperson_idtextRequired
Your MileIQ user. Select your connected profile or enter its ID.
Classificationclassificationtext
Drive classificationOne of: business, personal, all.
Limitlimitnumber
The number of drives to retrieveFrom 1 to 1000.
Date beforedate_beforedate and time
The end date of the range to retrieve drives for based on the defined filter_by param (exclusive). Filter_by needs to be set for this field to be used. Should be in UTC
Date afterdate_afterdate and time
The start date of the range to retrieve drives for based on the defined filter_by param (exclusive). Filter_by needs to be set for this field to be used. Should be in UTC
Filter byfilter_bytext
Use 'ended' to filter by the date the drive has ended. Use 'modified' to filter by the date the drive was last updatedOne of: modified, ended.

Outputs

Value.

dataobject
The API response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value, or empty at the end.
Example output
{
  "data": {
    "has_more": false,
    "results": [
      {
        "classification": "business",
        "created": "2026-10-01T12:00:00Z",
        "description": "example",
        "distance": {
          "amount": 1,
          "units": "mi"
        },
        "drive_id": 1,
        "end": {
          "address": {},
          "lat": "example",
          "lon": "example",
          "name": "example",
          "time": "2026-10-01T12:00:00Z"
        },
        "ended_at": "2026-10-01T12:00:00Z",
        "entry": "manual",
        "modified": "2026-10-01T12:00:00Z",
        "parking_fees": {
          "amount": 1,
          "currency": "USD"
        },
        "purpose": "example",
        "start": {
          "address": {},
          "lat": "example",
          "lon": "example",
          "name": "example",
          "time": "2026-10-01T12:00:00Z"
        },
        "started_at": "2026-10-01T12:00:00Z",
        "toll_fees": {
          "amount": 1,
          "currency": "USD"
        },
        "value": {
          "amount": 1,
          "currency": "USD"
        }
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

On this page