Downloading a list of contracts created in all routes.
GET
/ext/contracts-api/v2/contracts
Request Authorization
Every request MUST include a valid access token obtained during the user authorization process, provided using the Bearer token scheme in the Authorization header.
Successful Response
Error Response
Request Header
GET /ext/contracts-api/v2/contracts HTTP/1.1
Host: api.platform.trans.eu
Content-Type: application/json
Accept: application/json
Authorization: Bearer {access_token)
Api-key: {unique_app_api-key}Request Parameters (Query)
Pagination
By default, 10 results are download. You can change the number of results with the limit parameter, and you can skip fetching the initial results with the offset parameter.
/ext/contracts-api/v2/contracts?limit=15 // downloading first 15 results
/ext/contracts-api/v2/contracts?limit=10&offset=10 // downloading the second page for pages of size 10Response Fields
| Attribute | Type | Example | Description |
| _embedded | Object | Contains a route table | |
| _embedded.contracts | Array of Objects | Contains a list of contracts. Definition of contract object in the list is described in Get contract details | |
| has_more | Boolean | True | Availability indicator for next results from the route list |
Response Body
{
"_embedded": {
"contracts": [
{
"id": "e47ba26f-cebe-476e-a29a-df4c1fd0ab23",
"base_contract_id": "e47ba26f-cebe-476e-a29a-df4c1fd0ab23",
"type": "fixed",
"position": null,
"carrier": {
"company": {
"id": 562768,
"name": "123Logic"
},
"contact_persons": []
},
"deactivations": [],
"order_terms": {
"monitoring": {
"required": true
},
"additional_terms": "dodatkowe ustalenia",
"insurance": {
"load": {
"value": 20000,
"currency": "eur"
},
"third_party": {
"value": 1000000,
"currency": "eur"
}
},
"automatic_order_sending": true,
"payment_period": {
"value": 30
},
"silent_confirmation": {
"enabled": false,
"time": null
},
"autoresponder": {
"enabled": false,
"time": null
}
},
"period": {
"from": "2020-01-08T00:00:00+00:00",
"to": "2020-01-24T23:59:59+00:00"
},
"percentage_share": 0,
"planned_shipments": {
"periods": [
{
"value": 10,
"from": "2020-01-08T00:00:00+00:00",
"to": "2020-01-17T23:59:59+00:00"
},
{
"value": 11,
"from": "2020-01-09T00:00:00+00:00",
"to": "2020-01-16T23:59:59+00:00"
}
],
"type": "expected",
"unit": "km",
"value": 500
},
"pricing": {
"negotiable": false,
"type": "route",
"price": {
"value": 2000,
"currency": "pln"
},
"fuel_base_price": {
"value": null,
"currency": "pln"
}
},
"reference_number": "Warunki_ref1",
"route": {
"id": "2b5b5230-3c46-4861-8232-a3de7076ce2f",
"unique_key": null,
"name": "Testowa_trasa",
"publication_scenario": null,
"spots": [
{
"id": "4ce3e964-8891-4b4e-a1e5-bf1464929857",
"name": "Początek trasy",
"type": "loading",
"place": {
"address": {
"locality": "Wrocław",
"postal_code": "53-146",
"country": "pl",
"street": "Racławicka",
"number": "2-4",
"location_id": 1185465,
"detailed_location_id": 59620235,
"foreign_id": null,
"radius": null
},
"coordinates": {
"latitude": 51.08429,
"longitude": 17.0095
}
}
},
{
"id": "08345788-2cff-4470-8e27-da8811d1e91b",
"name": "Koniec trasy",
"type": "unloading",
"place": {
"address": {
"locality": "Nowy Sącz",
"postal_code": "33-300",
"country": "pl",
"street": "Nowa",
"number": "16",
"location_id": null,
"detailed_location_id": null,
"foreign_id": null,
"radius": 5000
},
"coordinates": {
"latitude": 49.62177,
"longitude": 20.69705
}
}
}
],
"distance": {
"declared": null,
"calculated": {
"value": 127.4406,
"unit_code": "km"
}
},
"suggested_calculated_route_id": null,
"distance_match": {
"min": null,
"max": null
},
"is_roundtrip": false,
"requirements": {
"required_truck_bodies": [
"mega",
"curtainsider"
],
"required_adr_classes": [
"adr_1",
"adr_1_1"
],
"required_ways_of_loading": [
"top",
"side",
"back"
],
"additional_requirements": [
"gps",
"lift"
],
"shipping_remarks": "inne wymagania testowe",
"freight_type": null,
"vehicle_size": "lorry",
"width": {
"value": 1,
"unit_code": "m"
},
"height": {
"value": 1,
"unit_code": "m"
},
"length": {
"value": 2,
"unit_code": "m"
},
"volume": {
"value": 2,
"unit_code": "m3"
},
"capacity": {
"min": null,
"max": {
"value": 21,
"unit_code": "t"
}
},
"exemption_from_adr": false
},
"loads": [
{
"name": "rodzaj_ładunku1",
"type_of_load": "palette",
"amount": 12,
"width": {
"value": 1,
"unit_code": "m"
},
"height": {
"value": 1,
"unit_code": "m"
},
"length": {
"value": 2,
"unit_code": "m"
},
"volume": {
"value": 2,
"unit_code": "m3"
},
"weight": {
"min": null,
"max": null
},
"pallets": {
"is_stackable": true,
"is_exchangeable": true
}
}
],
"balancing": {
"type": "manual",
"allowed_types": [
"manual",
"contract_condition",
"freight_limit",
"percentage_share",
"price_ascending"
],
"data": {
"freight_limit": {
"min": null,
"max": null
}
}
},
"status": "active",
"shipments_summary": {
"amount": 0,
"weight": {
"value": 0,
"unit_code": "t"
},
"distance": {
"value": 0,
"unit_code": "km"
},
"price": [
{
"amount": null,
"currency": null
}
]
},
"position": 217,
"_stats": {
"contracts": {
"fixed": 0,
"flexible": 0
},
"transports": {
"realized": {
"average_price": null,
"count": 0
},
"awaiting": {
"median_price": null,
"count": null
},
"cheapest_carrier_offer": null
}
}
},
"shipper": {
"company": {
"id": 1007374,
"name": "Firma Testowa Spedycja IIT"
},
"contact_persons": [
{
"id": "e54a2abc-c2cc-44c6-b9d0-e2a674fa31e9",
"employee": {
"id": 979241,
"account_id": 749989,
"given_name": "Barbara",
"family_name": "Kowal",
"trans_id": "1007374-1",
"email": "bkowal@mail.com",
"telephone": "(0048) 424743503"
},
"channels": [
"email",
"push",
"web-push",
"messenger"
],
"reported_by": {
"company": {
"id": 1007374
}
}
}
],
"cooperation_status": "active"
},
"status": "finished",
"_stats": {
"transports": {
"realized": null,
"average_per_month": null,
"awaiting": null
},
"offers": {
"accepted": null,
"total": null,
"acceptance_rate": null
},
"base_contract": {
"registered": 0,
"waiting_for_acceptance": 0,
"waiting_for_initial_carrier_offer": 0,
"waiting_for_shipper_offer": 0,
"waiting_for_carrier_offer": 0,
"refused": 0,
"accepted": 0,
"active": 0,
"finished": 1
}
},
"_meta": {
"is_copy": false,
"is_parent": false,
"has_been_sent_to_carrier": true
},
"updated_at": "2026-03-23T15:45:12+00:00",
"last_modification_date": "2026-03-23T15:45:12+00:00",
"surcharges": []
},
{
"shipper": {
"cooperation_status": "active",
"company": {
"name": "Spedycja IIT",
"id": 1007374
},
"contact_persons": [
{
"channels": [
"email",
"push",
"web-push",
"messenger"
],
"reported_by": {
"company": {
"id": 1007374
}
},
"id": "83904990-2eb9-4192-be49-7c86a44f9286",
"employee": {
"account_id": 765361,
"trans_id": "1007374-5",
"telephone": null,
"id": 993848,
"given_name": "Jan",
"family_name": "Nowak",
"email": "jnowak@mail.com"
}
}
]
},
"period": {
"from": "2026-04-15T11:29:15+00:00",
"to": null
},
"_stats": {
"offers": {
"total": null,
"accepted": null,
"acceptance_rate": null
},
"transports": {
"awaiting": null,
"realized": null,
"average_per_month": null
},
"base_contract": {
"registered": 0,
"waiting_for_acceptance": 0,
"waiting_for_initial_carrier_offer": 0,
"waiting_for_shipper_offer": 0,
"waiting_for_carrier_offer": 0,
"refused": 0,
"accepted": 0,
"active": 1,
"finished": 0
}
},
"_meta": {
"has_been_sent_to_carrier": true
},
"percentage_share": 80,
"type": "flexible",
"base_contract_id": "0dfc855d-ae8d-4d08-a8d4-a3375f8b78f9",
"carrier": {
"cooperation_status": "active",
"company": {
"name": "Carrier IIT 2",
"id": 1013865
},
"contact_persons": [
{
"channels": [
"email",
"push",
"web-push",
"messenger"
],
"reported_by": {
"company": {
"id": 1007374
}
},
"id": "49b28852-9d7c-49d3-aef5-b5867c9dbb29",
"employee": {
"account_id": 771476,
"trans_id": "1013865-3",
"telephone": "(0048) 12345678",
"id": 999446,
"given_name": "Jan",
"family_name": "Nowak",
"email": "jnowak@mail.com"
}
}
]
},
"route": {
"requirements": {
"additional_requirements": [],
"length": null,
"shipping_remarks": null,
"exemption_from_adr": false,
"required_adr_classes": [],
"capacity": {
"min": null,
"max": null
},
"volume": null,
"required_ways_of_loading": [],
"vehicle_size": null,
"width": null,
"freight_type": null,
"required_truck_bodies": [],
"height": null
},
"distance": {
"declared": null,
"calculated": {
"unit_code": "km",
"value": 4
}
},
"distance_match": {
"min": null,
"max": null
},
"is_roundtrip": false,
"unique_key": "456788",
"publication_scenario": {
"data": {
"publication_time": {
"unit_code": "s",
"value": 300,
"user_unit_code": "min"
},
"order": "next_recipient"
},
"type": "in_order"
},
"_stats": {
"transports": {
"cheapest_carrier_offer": null,
"awaiting": {
"count": null,
"median_price": null
},
"realized": {
"average_price": null,
"count": 0
}
},
"contracts": {
"flexible": 0,
"fixed": 0
}
},
"loads": [
{
"volume": null,
"amount": null,
"pallets": {
"is_stackable": false,
"is_exchangeable": false
},
"name": null,
"width": null,
"length": null,
"weight": {
"min": null,
"max": null
},
"type_of_load": null,
"height": null
}
],
"balancing": {
"type": "freight_limit",
"allowed_types": [
"manual",
"freight_limit",
"percentage_share"
],
"data": {
"freight_limit": {
"min": 30,
"max": 70
}
}
},
"suggested_calculated_route_id": "fa4c5378-0ccc-4737-90d2-efec0a1dd1a8",
"shipments_summary": {
"amount": 0,
"distance": {
"unit_code": "km",
"value": 0
},
"price": [
{
"amount": null,
"currency": null
}
],
"weight": {
"unit_code": "t",
"value": 0
}
},
"name": "Route2",
"spots": [
{
"name": "Początek PL 50-002 2021-08-11 13:51:15",
"id": "287b8962-bb35-4012-938c-3eed57d52596",
"place": {
"address": {
"foreign_id": null,
"country": "pl",
"number": "2",
"detailed_location_id": null,
"street": "Nowa",
"locality": "Wrocław",
"postal_code": "50-002",
"radius": null,
"location_id": 2513724
},
"coordinates": {
"latitude": 51.1,
"longitude": 17.03333
}
},
"type": "loading"
},
{
"name": "Początek trasy",
"id": "078e89c1-dcca-417f-9973-569cb87279c2",
"place": {
"address": {
"foreign_id": null,
"country": "pl",
"number": "2-4",
"detailed_location_id": 58279582,
"street": "Racławicka",
"locality": "Wrocław",
"postal_code": "53-146",
"radius": null,
"location_id": 1185465
},
"coordinates": {
"latitude": 51.0825872,
"longitude": 17.0038841
}
},
"type": "unloading"
}
],
"id": "3a378345-1939-48c1-bc71-639e0add8048",
"position": 231,
"status": "active"
},
"updated_at": "2026-04-27T12:35:19+00:00",
"deactivations": [],
"last_modification_date": "2026-04-27T12:35:19+00:00",
"id": "0dfc855d-ae8d-4d08-a8d4-a3375f8b78f9",
"position": 1,
"pricing": {
"price": {
"currency": null
},
"type": "no_rate"
},
"status": "accepted",
"surcharges": []
}
]
},
"has_more": true
}Client errors (code 400)
HTTP 4xx status codes indicate client errors, meaning that the request could not be processed due to an issue on the client side.