Get list of private exchange branded members

It allows you to get a com­plete list of pri­vate exchange brand­ed mem­bers added to a par­tic­u­lar pri­vate exchange brand­ed.

Url parameters and connection settings

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

Headers:

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization

Autho­riza­tion process is described here.

Available filters

List of avail­able fil­ters

  • role (?filter={“role”:{“$in”:[“principal”]}})
  • id  (?filter={“id”:{“$eq”:”asd123″}})
  • local­i­ty (?filter={“locality”:{“$rlike”:“asd”}})
  • com­pa­ny coun­try (?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 call­ing GET method, page should be added as para­me­ter in the URL, for exam­ple: https://api.platform.trans.eu/ext/corporate-exchange-api/v1/corporate-exchange/{private_exchange_branded_id}/members?page=4