1. Trans.eu Api
  2. Freights section
  3. Get branded private exchanges list

Get branded private exchanges list

Down­load­ing a list of brand­ed pri­vate exchanges your com­pa­ny has access to.

The response con­tains a pri­vate exchange ID that is required for the sub­se­quent pub­li­ca­tion request.

GET
/ext/corporate-exchange-api/v1/corporate-exchange
Request Authorization

Every request MUST include a valid access token obtained dur­ing the user autho­riza­tion process, pro­vid­ed using the Bear­er token scheme in the Autho­riza­tion head­er.

Request

Request Head­er

Successful Response

Response Fields

Response Body

Error Response

Client errors (400)

Gen­er­al API errors

Request Header
GET /ext/corporate-exchange-api/v1/corporate-exchange 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}
Response Fields
AttributeTypeExam­pleDescrip­tion
corporate_exchangesArray of ObjectsCon­tain­er with pri­vate exchange descrip­tion
corporate_exchanges.created_atString“2021–09-09T06:06:25+00:00”Date of cre­ation of the exchange
corporate_exchanges.created_byObjectUser cre­at­ing the exchange
corporate_exchanges.created_by.employeeObjectUser cre­at­ing the exchange
corporate_exchanges.created_by.employee.account_idInt758999Account ID of the user cre­at­ing the exchange
corporate_exchanges.idString“051d6148-903a-4735-bc57-feebfd­d8c900”Pri­vate exchange ID
corporate_exchanges.membersObjectYour com­pa­ny’s roles on pri­vate exchange
corporate_exchanges.members.rolesArray of String[“principal”,“mandatory”]List of roles. Pos­si­ble val­ues
administrator ‑man­age­ment of rights on the exchange,
principal — per­mis­sions to pub­lish on the exchange,
mandatory — per­mis­sions to search freights on the exchange.
exchanges.nameString“Cor­po­rate exchange”Pri­vate exchange name
exchanges.statusString“active”Pri­vate exchange sta­tus
exchanges.typeString“2_corporate”Pri­vate exchange type. Pos­si­ble val­ues 1_private, 2_corporate.
has_next_pageBooleanFalseIndi­cates whether there are sub­se­quent pages
pageInt1Cur­rent page num­ber
page_sizeInt1Page size
Response Body
{
    "corporate_exchanges": [
        {
            "created_at": "2026-02-09T13:23:28.832Z",
            "created_by": {
                "employee": {
                    "account_id": 758999
                }
            },
            "id": "006e95ea-f307-4a67-bc28-336dfc1cd679",
            "member": {
                "roles": [
                    "principal",
                    "mandatory"
                ]
            },
            "name": "API test",
            "status": "active",
            "type": "2_corporate"
        },
        {
            "created_at": "2021-10-07T11:17:21.000Z",
            "created_by": {
                "employee": {
                    "account_id": 749989
                }
            },
            "id": "49b9aa2b-1987-48d9-9a77-147f97594233",
            "member": {
                "roles": [
                    "administrator",
                    "principal"
                ]
            },
            "name": "Private",
            "status": "active",
            "type": "1_private"
        }
    ],
    "has_next_page": false,
    "page": 1,
    "page_size": 2
}

Client errors (code 400)

HTTP 4xx sta­tus codes indi­cate client errors, mean­ing that the request could not be processed due to an issue on the client side. Below is a list of request-spe­cif­ic errors.

Example response 1

No pri­vate exchanges

{
    "corporate_exchanges": [],
    "has_next_page": false,
    "page": 1,
    "page_size": 0
}