Allows to acquire list of user’s company employees

Authorization and access

Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.

For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.

Query parameters

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/companies-api/v1/companies/employees
  • Http Method: GET

Headers

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

Example request

GET https://api.platform.trans.eu/ext/companies-api/v1/companies/employees

Example response

[
    {
        "account_id": 98765,
        "family_name": "Example Name 1",
        "given_name": "Surname",
        "trans_id": "123-1"
    },
    {
        "account_id": 98764,
        "family_name": "Example Name 2",
        "given_name": "Surname",
        "trans_id": "123-2"
    },
    {
        "account_id": 98763,
        "family_name": "Example Name 3",
        "given_name": "Other Surnmae",
        "trans_id": "123-3"
    }
]