Allows to get full list of contractors added in Contractors module using Trans.eu Platform.
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/partners-api/v1/partners
- Method: GET
Headers:
- Content-type: application/json
- Accept: application/json
- Authorization: Bearer {access_token}
Authorization
Authorization process is described here.
For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.
Example request
GET https://api.platform.trans.eu/ext/partners-api/v1/partners
Example response
Sample Json response for contractors list containing only one contractor.
"page": 1,
"page_count": 5,
"page_size": 15,
"partners": [
{
"id": "d1da6d90-b787-4086-a515-09a82203eabf",
"groups": [
{
"id": "8460ce1a-a74b-488f-8fb7-df969e7a5aef",
"name": "Group name",
"description": "Example escription"
}
],
"company": {
"address": {
"country": "pl",
"locality": "Pmtlhoqprk",
"number": null,
"postal_code": "19-598",
"street": "Zrwdgrrh 72"
},
"email": "mmorawski@trans.eu",
"fax": "0048 287433053",
"financial_verification_status": "POSITIVE",
"id": 1038201,
"name": "Automaty DEV TFC",
"permissions": {
"is_authorized": true,
"is_blocked": false,
"was_authorized_at_least_once": true
},
"roles": [
"CARRIER"
],
"status": "ACTIVE",
"telephone": "0048 872156041",
"type": "STANDARD",
"vat_id": "PL9211968281"
}
}
]
}