API docs by Redocly

Fleet API (0.5.0)

Download OpenAPI specification:

SmartDrive Developer: developer@smartdrive.co.jp License: Proprietary

Fleet APIは、SmartDriveが提供する車両管理データを外部システムと連携するためのAPIです。

認証方式

Bearer Token認証を使用します。

Authorization: Bearer sdfl_v1_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

トークンはsdfl_v1_プレフィックス + 32文字のランダム文字列で構成されます。

レート制限

  • 1分あたり100リクエスト
  • 月間リクエスト上限はOrganization/User単位で設定

レスポンス形式

  • 一覧: {"data":[...], "meta":{...}, "pagination":{...}}
    • paginationでは、cursorベースのページングを採用しており、次のページが存在する場合はhas_nextがtrueで返されます。
      • limitよりも少ない件数が返されることがあるため、has_nextの値で次のページの存在を判断してください。
  • 詳細: {"data":{...}, "meta":{...}}
  • 日時: RFC3339形式（date-time）

ユーザー

ユーザー情報取得

ユーザー 一覧

組織に所属するユーザーの一覧を取得します。 既定の並び順はID降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "display_name"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 100 characters
Example: keyword=田中

キーワード検索（部分一致）。ユーザー名、メールアドレスを対象に検索します。

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

ユーザー 詳細

指定したIDのユーザー情報を取得します。

Authorizations:
bearer_token
path Parameters
id
required
integer >= 1
Example: 5252

ユーザーID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

車両

車両情報取得

車両 一覧

組織に所属する車両の一覧を取得します。 既定の並び順はID降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "name" "last_used_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 100 characters
Example: keyword=ネクサス

キーワード検索（部分一致）。車両名を対象に検索します。

entity_group_ids
string
Example: entity_group_ids=1,2,3

車両グループIDで絞り込み（カンマ区切りで複数指定可）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

車両 詳細

指定したIDの車両情報を取得します。

Authorizations:
bearer_token
path Parameters
id
required
integer >= 1
Example: 123

車両ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

デバイス

デバイス情報取得

デバイス 一覧

組織に所属するデバイスの一覧を取得します。 既定の並び順はID降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "code" "created_at" "updated_at" "last_used_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 32 characters
Example: keyword=2211000049

キーワード検索（部分一致）。device code（display_name）を対象に検索します。

device_group_ids
string
Example: device_group_ids=1,2,3

デバイスグループIDで絞り込み（カンマ区切りで複数指定可）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    },
  • "pagination": {
    }
}

デバイス 詳細

指定したdevice codeのデバイス情報を取得します。

Authorizations:
bearer_token
path Parameters
device_code
required
string
Example: device:SmartDrive:SD4V2-LTE:2211000049

device code。完全修飾のcodeを指定する。

例: device:SmartDrive:SD4V2-LTE:2211000049

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

デバイス最終位置情報

デバイス最終位置情報（リアルタイム走行情報）取得

デバイス最終位置情報 一覧

組織に所属するデバイス・車両・ドライバーの最新の位置・走行状態（リアルタイム走行情報）の一覧を取得します。 位置や住所による絞り込み、グループや走行ステータスによる絞り込みが可能です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

latlng
string
Example: latlng=35.681236,139.767125

検索の中心となる緯度経度。緯度,経度（カンマ区切りの数値2要素）形式で指定します。 radiusと組み合わせて範囲検索に使用します。 フォーマットが不正な場合は 400 (INVALID_PARAMETER) を返します。

address
string
Example: address=東京都千代田区

検索の中心となる住所。 radiusと組み合わせて範囲検索に使用します。

radius
integer >= 1
Example: radius=1000

検索範囲（メートル）。latlngまたはaddressと組み合わせて使用します。

device_group_ids
string
Example: device_group_ids=1,2,3

デバイスグループIDで絞り込み（カンマ区切りで複数指定可）

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

vehicle_group_ids
string
Example: vehicle_group_ids=1,2,3

車両グループIDで絞り込み（カンマ区切りで複数指定可）

status
string
Enum: "driving" "stop"
Example: status=driving

走行ステータスで絞り込み。

  • driving: 走行中
  • stop: 停止中
driving_statuses
string
Example: driving_statuses=driving,stopped

走行状態で絞り込み（カンマ区切りで複数指定可）。

  • driving: 走行中
  • stopped: 停止中
  • unknown: 不明
device_statuses
string
Example: device_statuses=online,offline

デバイス状態で絞り込み（カンマ区切りで複数指定可）。

  • online: オンライン
  • offline: オフライン

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

地点

地点情報取得

地点 一覧

組織に登録されている地点の一覧を取得します。 キーワード検索（地点名または住所の部分一致）や、地理的検索（指定座標からの半径内）に対応しています。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Example: sort=id

ソートフィールド（デフォルト: id）。指定可能な値はエンドポイントごとに異なります。

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string
Example: keyword=東京

キーワード（地点名または住所の部分一致検索）

latitude
number <double>
Example: latitude=35.681236

緯度（地理的検索用。longitude, radius と共に指定）

longitude
number <double>
Example: longitude=139.767125

経度（地理的検索用。latitude, radius と共に指定）

radius
integer
Example: radius=1000

検索範囲（メートル）。latitude, longitude と共に指定されたときのみ有効

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

地点 詳細

指定したIDの地点情報を取得します。

Authorizations:
bearer_token
path Parameters
id
required
integer >= 1
Example: 123

地点ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

管理スペース

管理スペース情報取得

管理スペース一覧

組織に登録されている管理スペースの一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "updated_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 128 characters
Example: keyword=東京

キーワード検索（部分一致）。管理スペース名を対象に検索します。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

管理スペース詳細

指定したIDの管理スペース情報を取得します。

Authorizations:
bearer_token
path Parameters
management_space_id
required
integer >= 1
Example: 123

管理スペースID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

ユーザーグループ

ユーザーグループ情報取得

ユーザーグループ一覧

組織に登録されているユーザーグループの一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "name" "created_at" "updated_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 128 characters
Example: keyword=営業

ユーザーグループ名で絞り込むためのキーワード（部分一致）

exclude_team
string
Default: "false"
Enum: "true" "false"
Example: exclude_team=false

trueを指定すると管理スペースに紐づくユーザーグループを除外する

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

ユーザーグループ詳細

指定したIDのユーザーグループ情報を取得します。

Authorizations:
bearer_token
path Parameters
user_group_id
required
integer >= 1
Example: 123

ユーザーグループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

ユーザーグループ一覧

組織に登録されているユーザーグループの一覧を取得します。（フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "name" "created_at" "updated_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 128 characters
Example: keyword=営業

ユーザーグループ名で絞り込むためのキーワード（部分一致）

exclude_team
string
Default: "false"
Enum: "true" "false"
Example: exclude_team=false

trueを指定すると管理スペースに紐づくユーザーグループを除外する

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

ユーザーグループ詳細

指定したIDのユーザーグループ情報を取得します。（フラット表現）

Authorizations:
bearer_token
path Parameters
user_group_id
required
integer >= 1
Example: 123

ユーザーグループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

車両グループ

車両グループ情報取得

車両グループ一覧

組織に登録されている車両グループの一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "name" "created_at" "updated_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 128 characters
Example: keyword=営業

車両グループ名で絞り込むためのキーワード（部分一致）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

車両グループ詳細

指定したIDの車両グループ情報を取得します。

Authorizations:
bearer_token
path Parameters
vehicle_group_id
required
integer >= 1
Example: 123

車両グループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

車両グループ一覧

組織に登録されている車両グループの一覧を取得します。（フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "name" "created_at" "updated_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

keyword
string <= 128 characters
Example: keyword=営業

車両グループ名で絞り込むためのキーワード（部分一致）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

車両グループ詳細

指定したIDの車両グループ情報を取得します。（フラット表現）

Authorizations:
bearer_token
path Parameters
vehicle_group_id
required
integer >= 1
Example: 123

車両グループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

地点グループ

地点グループ情報取得

地点グループ一覧

組織に登録されている地点グループの一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Example: sort=id

ソートフィールド（デフォルト: id）。指定可能な値はエンドポイントごとに異なります。

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

地点グループ詳細

指定したIDの地点グループ情報を取得します。

Authorizations:
bearer_token
path Parameters
location_group_id
required
integer >= 1
Example: 123

地点グループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

地点グループ一覧

組織に登録されている地点グループの一覧を取得します。（フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Example: sort=id

ソートフィールド（デフォルト: id）。指定可能な値はエンドポイントごとに異なります。

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

地点グループ詳細

指定したIDの地点グループ情報を取得します。（フラット表現）

Authorizations:
bearer_token
path Parameters
location_group_id
required
integer >= 1
Example: 123

地点グループID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

日報

日報情報取得

日報 一覧

組織に所属するユーザーの日報一覧を取得します。 日付範囲の指定が必須です。既定の並び順は日付降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "date"
Value: "date"
Example: sort=date

ソートフィールド（デフォルト: date）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

date_from
required
string <date>
Example: date_from=2025-08-01

対象期間の開始日（YYYY-MM-DD形式）

date_to
required
string <date>
Example: date_to=2025-08-31

対象期間の終了日（YYYY-MM-DD形式）

user_ids
string
Example: user_ids=1,2,3

ユーザーIDで絞り込み（カンマ区切りで複数指定可）

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

approval_status
string
Default: "all"
Enum: "all" "unapproved" "approved" "updated_after_approval" "unapproved_or_updated_after_approval"

承認状態で絞り込み。APIトークンにdaily_summary_approval権限がない場合、このパラメータは無視される。

  • all: 全て表示（デフォルト）
  • unapproved: 未承認
  • approved: 承認済み
  • updated_after_approval: 承認後更新あり
  • unapproved_or_updated_after_approval: 未承認または承認後更新
alcohol_check_results
string
Example: alcohol_check_results=failure

アルコールチェック結果で絞り込み（カンマ区切りで複数指定可）

  • failure: 完了（異常）
  • unexecuted_before_driving: 未完了（運転前）
  • unexecuted_after_driving: 未完了（運転後）
daily_inspection_results
string
Example: daily_inspection_results=failure

日常点検結果で絞り込み（カンマ区切りで複数指定可）

  • failure: 異常あり
  • unexecuted: 未実施
  • uncompleted: 一部未実施
has_fuel_record
boolean

給油記録があるデータのみ取得する場合はtrue、ないデータのみ取得する場合はfalse

has_driving_record
boolean
Default: false

trueの場合、走行または運転記録がある日の日報のみに絞り込む。falseの場合、絞り込みなし。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

日報 詳細

指定したユーザーの指定日付の日報詳細を取得します。 日付の指定が必須です。

Authorizations:
bearer_token
path Parameters
user_id
required
integer >= 1
Example: 5252

ユーザーID

query Parameters
date
required
string <date>
Example: date=2025-08-24

対象日付（YYYY-MM-DD形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

走行履歴

走行履歴情報取得

走行履歴 一覧

組織に紐づく走行履歴の一覧を取得します。 既定の並び順は走行開始日時降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "started_at"
Enum: "started_at" "ended_at"
Example: sort=started_at

ソートフィールド（デフォルト: started_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

user_id
integer >= 1
Example: user_id=123

ユーザーIDによる絞り込み

entity_id
integer >= 1
Example: entity_id=456

エンティティID（車両）による絞り込み

device_id
integer >= 1
Example: device_id=789

デバイスIDによる絞り込み

statuses
string^(started|in-progress|finished|analyzing|anal...
Example: statuses=finished,analyzed

走行ステータスで絞り込み（カンマ区切りで複数指定可）

  • started: 走行開始。まだデータが1件もアップロードされていない
  • in-progress: 走行中。1件以上のデータがアップロードされている
  • finished: 走行終了。一定期間データのアップロードがない。未解析
  • analyzing: 解析中。診断データが順次生成されている
  • analyzed: 解析完了。診断データなどが生成されている
ts_from
string <date-time>
Example: ts_from=2026-01-01T00:00:00Z

日時フィルタ。指定した日時以降のデータを取得（RFC3339形式）

ts_to
string <date-time>
Example: ts_to=2026-01-31T23:59:59Z

日時フィルタ。指定した日時以前のデータを取得（RFC3339形式）

entity_group_ids
string
Example: entity_group_ids=1,2,3

車両グループIDで絞り込み（カンマ区切りで複数指定可）

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

走行履歴 詳細

指定したUUIDの走行履歴を取得します。

Authorizations:
bearer_token
path Parameters
driving_uuid
required
string <uuid>
Example: b0a80056-0210-4ae4-8484-a6c01f92e220

走行UUID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

走行履歴 トラックポイント一覧

指定したUUIDの走行に紐づくトラックポイントを取得します。 トラックポイントは走行中に取得したGPS情報を元に生成されます。

Authorizations:
bearer_token
path Parameters
driving_uuid
required
string <uuid>
Example: b0a80056-0210-4ae4-8484-a6c01f92e220

走行UUID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

月報(ユーザー)

月報情報取得(ユーザー)

月報一覧(ユーザー)

組織に所属するユーザーの月報一覧を取得します。 年月の指定が必須です。 対象月に走行・運転記録・アルコールチェック・日常点検・給油のいずれかがある日報を持つユーザーのデータを返却します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

year_month
required
string
Example: year_month=2025-08

対象年月（YYYY-MM形式）

user_id
integer
Example: user_id=1

ユーザーIDで絞り込み

user_group_id
integer
Example: user_group_id=1

ユーザーグループIDで絞り込み

has_driving_record
boolean
Default: false

trueの場合、対象月に走行または運転記録がある日報が1件以上あるユーザーのみに絞り込む。 falseの場合、対象月に走行・運転記録・アルコールチェック・日常点検・給油のいずれかがある日報が1件以上あるユーザーのみに絞り込む。

unapproved_by_user_id
integer
Example: unapproved_by_user_id=101

指定した承認者が承認していない月報（未承認または承認後更新あり）を絞り込む

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

月報詳細(ユーザー)

指定したユーザーの月報詳細情報を取得します。 年月の指定が必須です。

Authorizations:
bearer_token
path Parameters
user_id
required
integer >= 1
Example: 123

ユーザーID

query Parameters
year_month
required
string
Example: year_month=2025-08

対象年月（YYYY-MM形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

月報(車両)

月報情報取得(車両)

月報一覧(車両)

組織に登録されている車両の月報一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

year_month
required
string
Example: year_month=2023-04

年月によるフィルタ（指定した年月の月報を取得する。例：2023-04）

vehicle_id
integer >= 1
Example: vehicle_id=12345

車両IDによる絞り込み

entity_group_id
integer >= 1
Example: entity_group_id=1

車両グループIDによる絞り込み

has_driving_record
boolean
Default: false
Example: has_driving_record=false

対象月に走行または運転記録があるデータのみ取得する場合true

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

月報詳細(車両)

指定した車両の月報詳細情報を取得します。 年月の指定が必須です。

Authorizations:
bearer_token
path Parameters
vehicle_id
required
integer >= 1
Example: 123

車両ID

query Parameters
year_month
required
string
Example: year_month=2023-04

対象年月（YYYY-MM形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

走行動画

走行動画情報取得

走行動画一覧

組織に登録されている走行動画の一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

user_id
integer >= 1
Example: user_id=123

ユーザーIDによる絞り込み

entity_id
integer >= 1
Example: entity_id=456

エンティティID（車両）による絞り込み

device_id
integer >= 1
Example: device_id=789

デバイスIDによる絞り込み

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

entity_group_ids
string
Example: entity_group_ids=1,2,3

車両グループIDで絞り込み（カンマ区切りで複数指定可）

triggers
string
Example: triggers=hard_acceleration,hard_deceleration

トリガー種別で絞り込み（カンマ区切りで複数指定可）。有効値: impact, hard_handling, hard_acceleration, hard_deceleration, button, wobble, collision, lane_departure, drowsiness, distraction, long_driving_time, overspeed, object_detect_phone, start_delay, insufficient_inter_vehicle_distance, movie_request, unknown

ts_from
string <date-time>
Example: ts_from=2024-01-01T00:00:00Z

日時フィルタ。指定した日時以降のデータを取得（RFC3339形式）

ts_to
string <date-time>
Example: ts_to=2024-01-31T23:59:59Z

日時フィルタ。指定した日時以前のデータを取得（RFC3339形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

走行動画詳細

指定した走行動画の情報を取得します。

Authorizations:
bearer_token
path Parameters
movie_event_id
required
string
Example: 3f595cf2-46b7-447b-8093-5d04fa8b1d87

走行動画ID（UUID形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

走行動画リクエスト一覧

組織に登録されている走行動画リクエストの一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "requested_at"
Value: "requested_at"
Example: sort=requested_at

ソートフィールド（デフォルト: requested_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

給油

給油記録取得

給油一覧

組織に登録されている給油記録の一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

fueled_at_from
required
string <date-time>
Example: fueled_at_from=2024-01-01T00:00:00Z

給油日時の開始（fueled_at >=）。RFC3339形式

fueled_at_to
required
string <date-time>
Example: fueled_at_to=2024-01-31T23:59:59Z

給油日時の終了（fueled_at <=）。RFC3339形式

account_id
integer >= 1
Example: account_id=123

アカウントIDでフィルタ

user_group_id
integer >= 1
Example: user_group_id=10

ユーザーグループIDでフィルタ

entity_id
integer >= 1
Example: entity_id=20000001

車両エンティティIDでフィルタ

entity_group_id
integer >= 1
Example: entity_group_id=5

車両グループIDでフィルタ

bulk_registration_id
integer >= 1
Example: bulk_registration_id=42

一括登録IDでフィルタ

has_no_receipt
boolean
Default: false
Example: has_no_receipt=false

trueの場合、レシート画像が登録されていない給油記録のみを取得

has_memo
boolean
Default: false
Example: has_memo=false

trueの場合、メモが入力されている給油記録のみを取得。Unicode の空白文字（半角 / 全角スペース、タブ、改行、ノーブレークスペース等）のみで構成されるメモは抽出対象外

has_no_vehicle
boolean
Default: false
Example: has_no_vehicle=false

trueの場合、車両が設定されていない給油記録のみを取得（entity_id, entity_group_idパラメーターは無視される）

has_no_account
boolean
Default: false
Example: has_no_account=false

trueの場合、実施者が設定されていない給油記録のみを取得（account_id, user_group_idパラメーターは無視される）

registration_type
string
Enum: "manual" "bulk"
Example: registration_type=manual

登録種別でフィルタ（manual: 手動登録, bulk: 一括登録）

sort
string
Default: "fueled_at"
Value: "fueled_at"
Example: sort=fueled_at

ソートフィールド（デフォルト: fueled_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

給油詳細

指定した給油記録の情報を取得します。

Authorizations:
bearer_token
path Parameters
fuel_record_id
required
integer >= 1
Example: 123

給油記録ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

日常点検

日常点検情報取得

日常点検一覧

組織に登録されている日常点検の一覧を取得します。 既定の並び順は確認日時（confirmed_at）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

user_id
integer >= 1
Example: user_id=100

ドライバーのユーザーIDでフィルタ

user_group_id
integer >= 1
Example: user_group_id=10

ユーザーグループIDでフィルタ

entity_id
integer >= 1
Example: entity_id=20000001

車両エンティティIDでフィルタ

entity_group_id
integer >= 1
Example: entity_group_id=5

車両グループIDでフィルタ

ts_from
string <date-time>
Example: ts_from=2026-03-01T00:00:00+09:00

確認日時の開始（confirmed_at >=）。ISO 8601形式

ts_to
string <date-time>
Example: ts_to=2026-03-31T23:59:59+09:00

確認日時の終了（confirmed_at <=）。ISO 8601形式

has_memo
boolean
Default: false
Example: has_memo=false

メモの有無でフィルタ（true=メモありのみ）。Unicode の空白文字（半角 / 全角スペース、タブ、改行、ノーブレークスペース等）のみで構成されるメモは抽出対象外

is_anomaly
boolean
Default: false
Example: is_anomaly=false

異常の有無でフィルタ（true=異常ありのみ）

template_name_keyword
string <= 128 characters
Example: template_name_keyword=車両点検

テンプレート名のキーワード検索（部分一致、最大128文字）

sort
string
Default: "confirmed_at"
Value: "confirmed_at"
Example: sort=confirmed_at

ソートフィールド（デフォルト: confirmed_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

日常点検詳細

指定した日常点検の情報を取得します。

Authorizations:
bearer_token
path Parameters
daily_inspection_id
required
integer >= 1
Example: 123

日常点検ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

車両予約

車両予約情報取得

車両予約一覧

組織に登録されている車両予約の一覧を取得します。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "started_at" "ended_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

ts_from
string <date-time>
Example: ts_from=2026-01-01T00:00:00Z

期間の開始時刻。ended_at がこの時刻より後の予約を返します（RFC3339形式）

ts_to
string <date-time>
Example: ts_to=2026-01-31T23:59:59Z

期間の終了時刻。started_at がこの時刻以前の予約を返します（RFC3339形式）

driver_user_id
integer >= 1
Example: driver_user_id=123

ドライバーユーザーIDによる絞り込み

registrant_user_id
integer >= 1
Example: registrant_user_id=456

予約登録者ユーザーIDによる絞り込み

entity_id
integer >= 1
Example: entity_id=789

車両エンティティIDによる絞り込み（単一）

entity_ids
string
Example: entity_ids=1,2,3

車両エンティティIDによる絞り込み（カンマ区切りで複数指定可）

entity_group_ids
string
Example: entity_group_ids=1,2,3

車両グループIDによる絞り込み（カンマ区切りで複数指定可）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

車両予約詳細

指定した車両予約の情報を取得します。

Authorizations:
bearer_token
path Parameters
reservation_id
required
integer >= 1
Example: 123

車両予約ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

運行工程

運行工程情報取得

運行工程 一覧（車両）

組織に登録されている車両の運行工程の一覧を取得します。

指定した期間（ts_from〜ts_to）に該当する運行工程を返します。date でソートします。

車両の絞り込みは entity_id で指定します。 ドライバーの絞り込みは driver_user_id で指定します。 ドライバーの絞り込みは details に含まれるドライバーを基準に運行工程を返すため、絞り込み対象以外のドライバーが details に含まれる場合もあります。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "date"
Value: "date"
Example: sort=date

ソートフィールド（デフォルト: date）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

ts_from
required
string <date-time>
Example: ts_from=2026-01-01T00:00:00Z

対象期間の開始日時。date がこの時刻以降の運行工程を返します（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2026-01-31T23:59:59Z

対象期間の終了日時。date がこの時刻以前の運行工程を返します（RFC3339形式）

entity_id
integer >= 1
Example: entity_id=123

車両エンティティIDによる絞り込み

driver_user_id
integer >= 1
Example: driver_user_id=456

ドライバーユーザーIDによる絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

運行工程 詳細（車両）

指定したIDの運行工程情報を取得します。

Authorizations:
bearer_token
path Parameters
vehicle_route_plan_id
required
integer >= 1
Example: 6374

運行工程ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

運行工程 一覧（ドライバー）

組織に登録されているドライバーの運行工程の一覧を取得します。

指定した期間（ts_from〜ts_to）に該当する運行工程を返します。date でソートします。

ドライバーの絞り込みは driver_user_id で指定します。 車両の絞り込みは entity_id で指定します。 車両の絞り込みは details に含まれる車両を基準に運行工程を返すため、絞り込み対象以外の車両が details に含まれる場合もあります。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "date"
Value: "date"
Example: sort=date

ソートフィールド（デフォルト: date）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

ts_from
required
string <date-time>
Example: ts_from=2026-01-01T00:00:00Z

対象期間の開始日時。date がこの時刻以降の運行工程を返します（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2026-01-31T23:59:59Z

対象期間の終了日時。date がこの時刻以前の運行工程を返します（RFC3339形式）

driver_user_id
integer >= 1
Example: driver_user_id=456

ドライバーユーザーIDによる絞り込み

entity_id
integer >= 1
Example: entity_id=123

車両エンティティIDによる絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

運行工程 詳細（ドライバー）

指定したIDの運行工程情報を取得します。

Authorizations:
bearer_token
path Parameters
driver_route_plan_id
required
integer >= 1
Example: 6373

運行工程ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

アルコールチェック

アルコールチェック情報取得

アルコールチェック 一覧

組織に所属するユーザーのアルコールチェック記録の一覧を取得します。 既定の並び順は確認日時（confirmed_at）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

user_id
integer >= 1
Example: user_id=100

ドライバーのユーザーIDでフィルタ

user_group_id
integer >= 1
Example: user_group_id=10

ユーザーグループIDでフィルタ

entity_id
integer >= 1
Example: entity_id=20000001

車両エンティティIDでフィルタ

entity_group_id
integer >= 1
Example: entity_group_id=5

車両グループIDでフィルタ

ts_from
string <date-time>
Example: ts_from=2026-03-01T00:00:00+09:00

確認日時の開始（confirmed_at >=）。ISO 8601形式

ts_to
string <date-time>
Example: ts_to=2026-03-31T23:59:59+09:00

確認日時の終了（confirmed_at <=）。ISO 8601形式

sort
string
Default: "confirmed_at"
Value: "confirmed_at"
Example: sort=confirmed_at

ソートフィールド（デフォルト: confirmed_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

has_instruction_memo
boolean
Default: false
Example: has_instruction_memo=false

指示メモの有無でフィルタ（true=指示メモありのみ）。Unicode の空白文字（半角 / 全角スペース、タブ、改行、ノーブレークスペース等）のみで構成される指示メモは抽出対象外

has_location
boolean
Default: false
Example: has_location=false

位置情報の有無でフィルタ（true=位置情報ありのみ）

input_method
string
Example: input_method=manual_input,ocr

アルコール濃度の入力方法でフィルタ（カンマ区切りで複数指定可。manual_input, ocr, checker_cooperation, alkiller）

observe_account_id
integer >= 1
Example: observe_account_id=2

立会人のアカウントIDでフィルタ

verification_statuses
string
Example: verification_statuses=pending,failed

確認ステータスでフィルタ（カンマ区切りで複数指定可。pending, passed, failed）

approval_status
string
Enum: "pending" "approved"
Example: approval_status=pending

承認ステータスでフィルタ（pending / approved）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

アルコールチェック 詳細

指定したIDのアルコールチェック記録を取得します。

Authorizations:
bearer_token
path Parameters
id
required
integer >= 1
Example: 123

アルコールチェックID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

運転記録

運転記録情報取得

運転記録 一覧

組織に紐づく運転記録の一覧を取得します。 既定の並び順は運転開始日時降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "started_at"
Value: "started_at"
Example: sort=started_at

ソートフィールド（デフォルト: started_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

user_id
integer >= 1
Example: user_id=100

ユーザーIDによる絞り込み

entity_id
integer >= 1
Example: entity_id=20000001

車両エンティティIDによる絞り込み

entity_group_ids
string
Example: entity_group_ids=1,2,3

車両グループIDで絞り込み（カンマ区切りで複数指定可）

user_group_ids
string
Example: user_group_ids=1,2,3

ユーザーグループIDで絞り込み（カンマ区切りで複数指定可）

ts_from
string <date-time>
Example: ts_from=2026-01-01T00:00:00Z

日時フィルタ。指定した日時以降の運転記録を取得（RFC3339形式）

ts_to
string <date-time>
Example: ts_to=2026-01-31T23:59:59Z

日時フィルタ。指定した日時以前の運転記録を取得（RFC3339形式）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

運転記録 詳細

指定した運転記録の情報を取得します。

Authorizations:
bearer_token
path Parameters
manual_input_driving_id
required
integer >= 1
Example: 1

運転記録ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

ジオフェンス

ジオフェンスイベント情報取得

ジオフェンスイベント 一覧

組織に紐づくジオフェンスイベント（地点への出入記録）の一覧を取得します。 既定の並び順はイベント発生日時（occurred_at）の降順です。

アクセス権限のない車両・ユーザーに紐づくイベントは、user または vehicle の各フィールドが "--" になります。 user・vehicle の両方に権限がないイベントは返却されません。

limitよりも少ない件数が返されることがあります（権限フィルタリングによる間引き）。 次のページの有無は pagination.has_next で判断してください。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

ts_from
required
string <date-time>
Example: ts_from=2026-03-01T00:00:00+09:00

イベント発生日時の開始（occurred_at >=）。ISO 8601形式

ts_to
required
string <date-time>
Example: ts_to=2026-03-31T23:59:59+09:00

イベント発生日時の終了（occurred_at <=）。ISO 8601形式

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

業務ステータス

業務ステータスイベント情報取得

業務ステータス 一覧

組織に所属するユーザーの業務ステータスイベント一覧を取得します。 既定の並び順はステータス切替日時（started_at）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

user_id
integer >= 1
Example: user_id=100

ユーザーIDでフィルタ

user_group_id
integer >= 1
Example: user_group_id=10

ユーザーグループIDでフィルタ

work_status_id
integer >= 1
Example: work_status_id=5

業務ステータスIDでフィルタ

ts_from
string <date-time>
Example: ts_from=2026-03-01T00:00:00+09:00

ステータス切替日時の開始（started_at >=）。ISO 8601形式

ts_to
string <date-time>
Example: ts_to=2026-03-31T23:59:59+09:00

ステータス切替日時の終了（started_at <=）。ISO 8601形式

sort
string
Default: "started_at"
Value: "started_at"
Example: sort=started_at

ソートフィールド（デフォルト: started_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

has_memo
boolean
Default: false
Example: has_memo=false

メモの有無でフィルタ（true=メモありのみ）。Unicode の空白文字（半角 / 全角スペース、タブ、改行、ノーブレークスペース等）のみで構成されるメモは抽出対象外

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

業務ステータスイベント 詳細

指定したIDの業務ステータスを取得します。

Authorizations:
bearer_token
path Parameters
id
required
integer >= 1
Example: 1001

業務ステータスイベントID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

作業

作業情報取得

作業一覧

組織に登録されている作業の一覧を取得します。 既定の並び順は完了期限日時（limit_at）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

user_id
integer >= 1
Example: user_id=100

作業担当者のユーザーIDでフィルタ。 user_group_idと同時指定した場合はuser_idが優先され、user_group_idは無視されます。

user_group_id
integer >= 1
Example: user_group_id=10

作業担当者が所属するユーザーグループIDでフィルタ。 user_idと同時指定した場合はuser_idが優先され、本パラメータは無視されます。

register_user_id
integer >= 1
Example: register_user_id=200

作業を登録したユーザーIDでフィルタ。 register_user_group_idと同時指定した場合はregister_user_idが優先され、register_user_group_idは無視されます。

register_user_group_id
integer >= 1
Example: register_user_group_id=20

作業を登録したユーザーが所属するユーザーグループIDでフィルタ。 register_user_idと同時指定した場合はregister_user_idが優先され、本パラメータは無視されます。

date_filter_field
string
Default: "limit_at"
Enum: "limit_at" "closed_at"
Example: date_filter_field=limit_at

ts_from / ts_to によるフィルタ対象の日時フィールド（limit_at: 完了期限日時, closed_at: 完了日時）

ts_from
string <date-time>
Example: ts_from=2026-03-01T00:00:00+09:00

date_filter_field で指定した日時の開始（>=）。RFC3339形式

ts_to
string <date-time>
Example: ts_to=2026-03-31T23:59:59+09:00

date_filter_field で指定した日時の終了（<=）。RFC3339形式

state
string
Default: "all"
Enum: "all" "open" "closed"
Example: state=all

作業の状態でフィルタ（all: 全て, open: 未完了, closed: 完了）

has_memo
boolean
Default: false
Example: has_memo=false

メモの有無でフィルタ（true=メモが1文字以上登録されている作業のみ）。Unicode の空白文字（半角 / 全角スペース、タブ、改行、ノーブレークスペース等）のみで構成されるメモは抽出対象外

title_keyword
string <= 256 characters
Example: title_keyword=電話対応

作業タイトルの部分一致検索キーワード

sort
string
Default: "limit_at"
Enum: "limit_at" "closed_at"
Example: sort=limit_at

ソートフィールド（デフォルト: limit_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

作業詳細

指定したIDの作業情報を取得します。

Authorizations:
bearer_token
path Parameters
work_task_id
required
integer >= 1
Example: 1

作業ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

整備記録

整備記録情報取得

整備記録一覧

指定された車両に紐づく整備記録の一覧を取得します。 既定の並び順は作成日時（created_at）の降順です。

Authorizations:
bearer_token
path Parameters
vehicle_id
required
integer >= 1
Example: 123

車両ID

query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "created_at"
Value: "created_at"
Example: sort=created_at

ソートフィールド（デフォルト: created_at）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

整備記録詳細

指定した整備記録の情報を取得します。

Authorizations:
bearer_token
path Parameters
vehicle_id
required
integer >= 1
Example: 123

車両ID

maintenance_id
required
integer >= 1
Example: 1

整備記録ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

整備記録一覧

指定された車両に紐づく整備記録の一覧を取得します。 既定の並び順は整備記録ID（id）の降順です。 （フラット表現。vehicle_id はクエリパラメータ）

Authorizations:
bearer_token
query Parameters
vehicle_id
required
integer >= 1
Example: vehicle_id=123

車両ID

cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "vehicle_id"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

整備記録詳細

指定した整備記録の情報を取得します。 （フラット表現。maintenance_id のみで取得し、親 vehicle_id は指定不要。 同一 enterprise 内かつアクセス可能な vehicle に紐づくものであれば、その vehicle を問わず取得できる）

Authorizations:
bearer_token
path Parameters
maintenance_id
required
integer >= 1
Example: 1

整備記録ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

保険

保険情報取得

保険情報一覧

指定した車両に紐づく保険情報の一覧を取得します。 既定の並び順は保険ID（id）の降順です。

Authorizations:
bearer_token
path Parameters
vehicle_id
required
integer >= 1
Example: 123

車両ID

query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "vehicle_id"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

保険情報詳細

指定した車両に紐づく保険情報の詳細を取得します。

Authorizations:
bearer_token
path Parameters
vehicle_id
required
integer >= 1
Example: 123

車両ID

insurance_id
required
integer >= 1
Example: 100

保険ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

保険情報一覧

指定した車両に紐づく保険情報の一覧を取得します。 既定の並び順は保険ID（id）の降順です。 （フラット表現。vehicle_id はクエリパラメータ）

Authorizations:
bearer_token
query Parameters
vehicle_id
required
integer >= 1
Example: vehicle_id=123

車両ID

cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "vehicle_id"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

保険情報詳細

保険情報の詳細を取得します。 （フラット表現。insurance_id のみで取得し、親 vehicle_id は指定不要。 同一 enterprise 内かつアクセス可能な vehicle に紐づくものであれば、その vehicle を問わず取得できる）

Authorizations:
bearer_token
path Parameters
insurance_id
required
integer >= 1
Example: 100

保険ID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

リマインダー

リマインダー情報取得

車検証リマインダー 一覧

車検証リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

リースリマインダー 一覧

リースリマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

保険リマインダー 一覧

保険リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

免許証リマインダー 一覧

免許証リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

user_group_id
integer >= 1
Example: user_group_id=100

ユーザーグループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

整備記録リマインダー 一覧

整備記録リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

車検証リマインダー 一覧

車検証リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

リースリマインダー 一覧

リースリマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

保険リマインダー 一覧

保険リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

免許証リマインダー 一覧

免許証リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

user_group_id
integer >= 1
Example: user_group_id=100

ユーザーグループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

整備記録リマインダー 一覧

整備記録リマインダーの一覧を取得します。 既定の並び順はリマインダーID（id）の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "id"
Enum: "id" "created_at" "reminded_at"
Example: sort=id

ソートフィールド（デフォルト: id）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

in_remind
boolean
Default: false
Example: in_remind=false

trueの時、リマインド期間内のリマインダーのみ取得します。デフォルトはfalse。

entity_group_id
integer >= 1
Example: entity_group_id=100

車両グループIDで絞り込み

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

期間集計

期間集計情報取得

期間集計 一覧（ユーザー軸）

任意の期間についてユーザー軸の走行データを指定した集計単位（全期間、月別、週別、日別）で集計します。 既定の並び順は集計期間開始日時の降順です。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "ts_from"
Value: "ts_from"
Example: sort=ts_from

ソートフィールド（デフォルト: ts_from）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

group_type
required
string
Enum: "user_id" "user_group_id" "user_group_id_for_users"
Example: group_type=user_id

集計タイプ

  • user_id: 指定したユーザーの走行データを集計
  • user_group_id: 指定したユーザーグループに所属する全ユーザーの走行データを集計
  • user_group_id_for_users: 指定したユーザーグループの各ユーザー単位で走行データを集計
user_id
integer >= 1
Example: user_id=123

ユーザーID。group_type=user_idの場合は必須

user_group_id
integer >= 1
Example: user_group_id=1

ユーザーグループID（ユーザーグループに所属する全ユーザーの走行データを集計）。group_type=user_group_idの場合は必須

user_group_id_for_users
integer >= 1
Example: user_group_id_for_users=1

ユーザーグループID（指定したユーザーグループの各ユーザーの走行データを集計）。group_type=user_group_id_for_usersの場合は必須

ts_from
required
string <date-time>
Example: ts_from=2023-03-01T00:00:00Z

集計期間の開始日時（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2023-03-10T23:59:59Z

集計期間の終了日時（RFC3339形式）。集計対象によって指定可能な範囲が制限されます。

  • group_type=user_id の場合、ts_from から最大1年まで
  • group_type=user_group_id / user_group_id_for_users の場合、ts_from から最大3ヶ月まで
aggregate_unit
string
Default: "all"
Enum: "all" "month" "week" "day"
Example: aggregate_unit=all

集計単位

  • all: 全期間
  • month: 月別
  • week: 週別
  • day: 日別

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

期間集計 一覧（車両軸）

任意の期間について車両軸の走行データを指定した集計単位（全期間、月別、週別、日別）で集計します。 既定の並び順は集計期間開始日時の降順です。 アクセス可能な車両は呼び出しユーザーが閲覧可能な車両（accessible_entity_ids）に限定されます。

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "ts_from"
Value: "ts_from"
Example: sort=ts_from

ソートフィールド（デフォルト: ts_from）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

group_type
string
Enum: "vehicle_id" "entity_group_id" "entity_group_id_for_vehicles"
Example: group_type=vehicle_id

集計タイプ

  • vehicle_id: 指定した車両の走行データを集計
  • entity_group_id: 指定した車両グループに所属する全車両の走行データを集計
  • entity_group_id_for_vehicles: 指定した車両グループの各車両単位で走行データを集計

all_vehicles=true の場合は省略可能。それ以外の場合は必須。 両方指定した場合は group_type が優先される。

vehicle_id
integer >= 1
Example: vehicle_id=123

車両ID。group_type=vehicle_idの場合は必須

entity_group_id
integer >= 1
Example: entity_group_id=1

車両グループID（車両グループに所属する全車両の走行データを集計）。group_type=entity_group_idの場合は必須

entity_group_id_for_vehicles
integer >= 1
Example: entity_group_id_for_vehicles=1

車両グループID（指定した車両グループの各車両の走行データを集計）。group_type=entity_group_id_for_vehiclesの場合は必須

all_vehicles
boolean
Default: false
Example: all_vehicles=true

アクセス可能な全車両を車両単位で集計する。true を指定した場合は group_type を省略可能。 group_type が指定された場合はそちらが優先され、all_vehicles は無視される。

制約: all_vehicles=true は aggregate_unit=month のみサポートします。それ以外を指定した場合は 400 が返ります。

ts_from
required
string <date-time>
Example: ts_from=2023-03-01T00:00:00Z

集計期間の開始日時（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2023-03-10T23:59:59Z

集計期間の終了日時（RFC3339形式）。集計対象によって指定可能な範囲が制限されます。

  • group_type=vehicle_id の場合、ts_from から最大1年まで
  • group_type=entity_group_id / entity_group_id_for_vehicles の場合、ts_from から最大3ヶ月まで
aggregate_unit
string
Default: "all"
Enum: "all" "month" "week" "day"
Example: aggregate_unit=all

集計単位

  • all: 全期間
  • month: 月別
  • week: 週別
  • day: 日別

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

期間集計 一覧（ユーザー軸）

任意の期間についてユーザー軸の走行データを指定した集計単位（全期間、月別、週別、日別）で集計します。 既定の並び順は集計期間開始日時の降順です。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "ts_from"
Value: "ts_from"
Example: sort=ts_from

ソートフィールド（デフォルト: ts_from）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

group_type
required
string
Enum: "user_id" "user_group_id" "user_group_id_for_users"
Example: group_type=user_id

集計タイプ

  • user_id: 指定したユーザーの走行データを集計
  • user_group_id: 指定したユーザーグループに所属する全ユーザーの走行データを集計
  • user_group_id_for_users: 指定したユーザーグループの各ユーザー単位で走行データを集計
user_id
integer >= 1
Example: user_id=123

ユーザーID。group_type=user_idの場合は必須

user_group_id
integer >= 1
Example: user_group_id=1

ユーザーグループID（ユーザーグループに所属する全ユーザーの走行データを集計）。group_type=user_group_idの場合は必須

user_group_id_for_users
integer >= 1
Example: user_group_id_for_users=1

ユーザーグループID（指定したユーザーグループの各ユーザーの走行データを集計）。group_type=user_group_id_for_usersの場合は必須

ts_from
required
string <date-time>
Example: ts_from=2023-03-01T00:00:00Z

集計期間の開始日時（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2023-03-10T23:59:59Z

集計期間の終了日時（RFC3339形式）。集計対象によって指定可能な範囲が制限されます。

  • group_type=user_id の場合、ts_from から最大1年まで
  • group_type=user_group_id / user_group_id_for_users の場合、ts_from から最大3ヶ月まで
aggregate_unit
string
Default: "all"
Enum: "all" "month" "week" "day"
Example: aggregate_unit=all

集計単位

  • all: 全期間
  • month: 月別
  • week: 週別
  • day: 日別

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

期間集計 一覧（車両軸）

任意の期間について車両軸の走行データを指定した集計単位（全期間、月別、週別、日別）で集計します。 既定の並び順は集計期間開始日時の降順です。 アクセス可能な車両は呼び出しユーザーが閲覧可能な車両（accessible_entity_ids）に限定されます。 （フラット表現）

Authorizations:
bearer_token
query Parameters
cursor
string
Example: cursor=

ページング開始するカーソル。未指定or空文字列の時は先頭からになります。

limit
integer [ 1 .. 100 ]
Default: 50
Example: limit=50

1ページあたりの件数（デフォルト: 50、最大: 100）

sort
string
Default: "ts_from"
Value: "ts_from"
Example: sort=ts_from

ソートフィールド（デフォルト: ts_from）

direction
string
Default: "desc"
Enum: "asc" "desc"
Example: direction=desc

ソート順（デフォルト: desc）

group_type
string
Enum: "vehicle_id" "entity_group_id" "entity_group_id_for_vehicles"
Example: group_type=vehicle_id

集計タイプ

  • vehicle_id: 指定した車両の走行データを集計
  • entity_group_id: 指定した車両グループに所属する全車両の走行データを集計
  • entity_group_id_for_vehicles: 指定した車両グループの各車両単位で走行データを集計

all_vehicles=true の場合は省略可能。それ以外の場合は必須。 両方指定した場合は group_type が優先される。

vehicle_id
integer >= 1
Example: vehicle_id=123

車両ID。group_type=vehicle_idの場合は必須

entity_group_id
integer >= 1
Example: entity_group_id=1

車両グループID（車両グループに所属する全車両の走行データを集計）。group_type=entity_group_idの場合は必須

entity_group_id_for_vehicles
integer >= 1
Example: entity_group_id_for_vehicles=1

車両グループID（指定した車両グループの各車両の走行データを集計）。group_type=entity_group_id_for_vehiclesの場合は必須

all_vehicles
boolean
Default: false
Example: all_vehicles=true

アクセス可能な全車両を車両単位で集計する。true を指定した場合は group_type を省略可能。 group_type が指定された場合はそちらが優先され、all_vehicles は無視される。

制約: all_vehicles=true は aggregate_unit=month のみサポートします。それ以外を指定した場合は 400 が返ります。

ts_from
required
string <date-time>
Example: ts_from=2023-03-01T00:00:00Z

集計期間の開始日時（RFC3339形式）

ts_to
required
string <date-time>
Example: ts_to=2023-03-10T23:59:59Z

集計期間の終了日時（RFC3339形式）。集計対象によって指定可能な範囲が制限されます。

  • group_type=vehicle_id の場合、ts_from から最大1年まで
  • group_type=entity_group_id / entity_group_id_for_vehicles の場合、ts_from から最大3ヶ月まで
aggregate_unit
string
Default: "all"
Enum: "all" "month" "week" "day"
Example: aggregate_unit=all

集計単位

  • all: 全期間
  • month: 月別
  • week: 週別
  • day: 日別

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ],
  • "pagination": {
    }
}

前日業務判定

業務日区切り時刻に基づき、実施時刻が前日業務に該当するかを判定する

前日業務判定（実施時刻から前日業務フラグの初期値を取得）

実施時刻 acted_at が「前日業務」に該当するかをサーバで判定して返します。 判定ロジックは企業ごとに設定された「業務日区切り時刻」に基づきます。

  • 判定式: 企業TZ で見た acted_at の時刻部分が、企業TZ で見た業務日区切り時刻より前なら true、それ以外（境界含む）は false。
  • 業務日区切り時刻が 00:00:00+<企業TZ>（区切りなし＝暦日どおり）に設定されている企業は、結果が常に false（暦日どおり）になります。
  • 呼び出し用途: 手動記録（アルコールチェック・日常点検・給油）の新規登録フォームの初期値支援。既存記録の編集時は呼ばず、呼び出し失敗時はフラグ false でフォームを継続表示してください。
  • 失敗時のフォールバック先（参考）: 403 PERSONAL_API_DISABLED / 403 MCP_ACCESS_DISABLED / 429 も同様に「フラグ false で続行」が安全な既定挙動です。
Authorizations:
bearer_token
query Parameters
acted_at
required
string <date-time>
Example: acted_at=2026-06-09T02:00:00+09:00

記録の実施時刻。タイムゾーン付き ISO 8601（RFC3339）形式で指定します（例: 2026-06-09T02:00:00+09:00）。 タイムゾーン無し（オフセット・Z のいずれも無い）の文字列は受け付けず 400 を返します。 query parameter のため、+ は URL エンコード（%2B）して送信してください。

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}