- Introduction
- Getting Started
- Authentication
- Error Handling
- Contact Support
- Modaltrans API
- Get Auth Token
- Accounting
- Customs
- Logistics
- Bookings
- Locations
- Positions
- Tracking
- Shipments
- Depot
- Fleet Management
- CRM
- Timelines
- S3 Files
- Notifications
- User Details
Get All Positions
Testing Env
https://demo.modaltrans.com
Testing Env
https://demo.modaltrans.com
GET
/api/v1/positions
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://demo.modaltrans.com/api/v1/positions?page=1&trans_method=sea&updated_at=2026-01-01' \
--header 'Authorization: Bearer <token>'Responses
🟢200OK
application/json
Body
Example
[
{
"uuid": "string",
"reference": "string",
"branch_id": 0,
"user_id": 0,
"status": "string",
"contract_type": "string",
"extref": "string",
"truck": "string",
"truck_type": "string",
"trailer": "string",
"trailer_type": "string",
"truck_uuid": "string",
"trailer_uuid": "string",
"driver_name": "string",
"driver_gsm": "string",
"route": "string",
"notes": "string",
"supplier_id": 0,
"supplier_name": "string",
"operator_name": "string",
"dep_place": {
"id": 0,
"code": "string",
"name": "string",
"place_type": "string",
"address": "string",
"city_name": "string",
"country_id": "string",
"lat": "string",
"lng": "string",
"gmaps_id": "string",
"gmaps_title": "string",
"notes": "string",
"local_name": "string"
},
"dep_place_name": "string",
"dep_city": {
"id": 0,
"code": "string",
"name": "string",
"tel_code": "string",
"country_id": "string",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"states_code": "string"
},
"dep_country_id": "string",
"estimated_dep_date": "2019-08-24T14:15:22.123Z",
"departure_date": "2019-08-24T14:15:22.123Z",
"arv_place": {
"id": 0,
"code": "string",
"name": "string",
"place_type": "string",
"address": "string",
"city_name": "string",
"country_id": "string",
"lat": "string",
"lng": "string",
"gmaps_id": "string",
"gmaps_title": "string",
"notes": "string",
"local_name": "string"
},
"arv_place_name": "string",
"arv_city": {
"id": 0,
"code": "string",
"name": "string",
"tel_code": "string",
"country_id": "string",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"states_code": "string"
},
"arv_country_id": "string",
"estimated_arv_date": "2019-08-24T14:15:22.123Z",
"arrival_date": "2019-08-24T14:15:22.123Z",
"transit_points": [
"string"
],
"untransit_points": [
"string"
],
"border_date": "2019-08-24",
"waybill_type": "string",
"route_km": "string",
"voyage": "string",
"operator_id": 0,
"tracking_eta": "14:15:22.123Z",
"tracking_etd": "14:15:22.123Z",
"departure_ship": [
{
"name": "string",
"imo_no": "string"
}
],
"arrival_ship": [
{
"name": "string",
"imo_no": "string"
}
],
"agent_id": 0,
"consigments": [
{
"transaction_id": 0,
"uuid": "string",
"reference": "string",
"trans_mode": "string",
"branch_id": 0,
"company_uuid": "string",
"company_name": "string",
"customer_ref": "string",
"agent_ref": "string",
"consignee_name": "string",
"consignee_email": "string",
"sender_name": "string",
"sender_email": "string",
"load_place_id": 0,
"load_city": "string",
"load_zipcode": "string",
"load_coun": "string",
"load_place": "string",
"load_date": "2019-08-24T14:15:22.123Z",
"unload_place_id": 0,
"unload_city": "string",
"unload_zipcode": "string",
"unload_coun": "string",
"unload_place": "string",
"unload_date": "string",
"brut_wg": 0,
"volume": 0,
"ladameter": 0,
"status": "string",
"commodity": "string",
"category": "string",
"group_id": 0,
"price_wg": 0,
"teu": 0,
"saler_name": "string",
"saler_email": "string",
"saler_office_tel": "string",
"total_pack": 0,
"carrier_name": "string",
"waybill_no": "string",
"truck_code": "string",
"vessel_code": "string",
"truck_type": "string",
"export_import": "string",
"free_time": "string",
"notes": "string",
"container_nos": [
{
"size": "string",
"container_no": "string"
}
],
"timelines": [
{
"id": 0,
"parent_type": "string",
"parent_id": 0,
"status_date": "2019-08-24T14:15:22.123Z",
"status_code": "string",
"place_id": 0,
"city_id": 0,
"country_id": "string",
"notes": "string",
"source": "string",
"group_id": 0,
"user_id": 0,
"patron_id": 0,
"customer_inform_type": true,
"customer_inform_status": "string",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z",
"lng": 0,
"lat": 0,
"place_name": "string",
"notify_senders": true,
"notify_consignees": true,
"notify_companies": true,
"tenant_id": 0,
"icon_code": "string",
"system_location": "string"
}
]
}
]
}
]🟠403Forbidden
🟠404Record Not Found
🟠400Bad Request
Modified at 2026-02-03 07:48:24