It allows you to get a complete list of private exchange branded members added to a particular private exchange branded.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/corporate-exchange-api/v1/corporate-exchange/{private_exchange_branded_id}/members
  • Method: GET

Headers:

  • Content-type: application/json
  • Accept: application/json
  • Authorization: Bearer {access_token}
  • Api-key: {unique_app_api-key}

Authorization

Authorization process is described here.

Available filters

List of available filters

  • role (?filter={“role”:{“$in”:[“principal”]}})
  • id  (?filter={“id”:{“$eq”:”asd123″}})
  • locality (?filter={“locality”:{“$rlike”:“asd”}})
  • company country (?filter={“country”:{“$in”: [“pl”]}})

Example response

{
    "corporate_exchange_members": [
        {
            "company": {
                "address": {
                    "country": "pl",
                    "locality": "Vhqwtwrqgi",
                    "postal_code": "74-507"
                },
                "id": 1007386,
                "name": "Firma Testowa Załadowca IIT",
                "vat_id": "PL8249474698"
            },
            "created_at": "2022-11-21T13:55:53.919Z",
            "created_by": {
                "employee": {
                    "account_id": 111111
                }
            },
            "roles": [
                "principal",
                "3_administrator"
            ]
        },
        {
            "company": {
                "address": {
                    "country": "pl",
                    "locality": "Tcfwuroyni",
                    "postal_code": "53-604"
                },
                "id": 1013865,
                "name": "Firma Testowa Przewoźnik IIT 2",
                "vat_id": "PL4574663803"
            },
            "created_at": "2022-11-21T13:58:02.817Z",
            "created_by": {
                "employee": {
                    "account_id": 222222
                }
            },
            "roles": [
                "mandatory"
            ]
        }
    ],
    "has_next_page": false,
    "page": 1,
    "page_size": 2
}

Paging

When calling GET method, page should be added as parameter in the URL, for example: https://api.platform.trans.eu/ext/corporate-exchange-api/v1/corporate-exchange/{private_exchange_branded_id}/members?page=4